Elan456/viking-village-builder

Build a village with limited resources and time to prepare for war

Invasion of London: Forkbeard's Call

https://github.com/Elan456/viking-village-builder

Table of Contents

• Invasion of London: Forkbeard's Call
  • Table of Contents
  • Setup instructions
    • 1. Downloading the Game (If you don't already have it)
      • Using Git
      • Downloading the ZIP
    • 2. Dependency Installation
    • 3. Running the game
  • Gameplay Instructions
    • Objective
    • First Steps
      • Getting Raw Resources
      • Building More Buildings
      • Advanced Resources
    • Controls
    • Win Condition
    • Building
    • Turn Management
    • Resource Panel
    • Crafting Dependencies
  • Credits
    • Programming
    • Music
    • Art
    • Tooling
  • Milestone Feature Breakdown
    • Final Project Milestone (11/21 - 12/9)
      • Notable Changes / Additions
    • Milestone 3 (10/31 - 11/20)
      • Features Added (with Point Values Adding to 100)
    • Milestone 2 (9/17 - 10/30)
      • Features Added

---

Setup instructions

Currently, the game is not packaged into an executable, so you will need to run it from the source code.

1. Downloading the Game (If you don't already have it)

Using Git

git clone https://github.com/Elan456/viking-village-builder.git
cd viking-village-builder

Downloading the ZIP

Visit the GitHub repository at viking-village-builder

1. Click the green "Code" button on the top right of the repository
2. Click "Download ZIP"
3. Extract the ZIP to a folder

2. Dependency Installation

Note: You may need to install Python 3.8 or higher to run the game. You can download it from https://www.python.org/downloads/

python -m pip install -r requirements.txt

This should install pygame and e-pyquadtree.

e-pyquadtree is a quadtree data structure package written by me, check it out on GitHub: https://github.com/Elan456/pyquadtree

3. Running the game

python main.py 

Gameplay Instructions

Objective

Your village has been selected to aid in the invasion of London. By placing buildings and managing resources, you must build an army of 250 warriors and 10 ships by turn 100.

First Steps

Getting Raw Resources

1. Your village starts with a few buildings and a wall.
2. You need to start accumulating basic resources: wood , ore , and food to craft weapons , warriors , and ships later
3. Click and drag the lumberyard building from the right panel to an empty space within your walls.
4. The ghost of the building will appear with a number indicating how many turns are left until it is built. The orange outline indicates that the building is currently being worked on.

Building More Buildings

1. With more builder's huts, you can build more buildings at once.
2. Click and drag the builder's hut from the right panel (hammer icon) to an empty space within your walls.

Advanced Resources

The buildings which produce Aadvanced resources such as weapons, warriors, and ships can have their production boosted by other buildings.

1. Click and drag a blacksmith building (axe icon) to an empty space within your walls.
2. Notice the blue lines indicating which buildings boost the blacksmith's production.
3. The boost amount is a multiplier on the base production rate of the blacksmith based on its proximity to the boosting buildings.

Controls

• "H" = Show Help Screen
• WASD / Arrow Keys / Middle-Click + Drag = Pan Camera
• Mouse for interacting with and placing buildings
• "N" to show the navigation mesh

Win Condition

• To win, you must have 250 warriors and 10 ships on turn 100.

Building

Click + drag on a building from the far-right panel to an empty space within your walls.

If the construction fails, a message will appear in the center to tell you why.

Common reasons for construction failure are:

• Not enough resources
• Shipyard not along the river
• Outside of the wall
• Building overlaps with another building

Turn Management

In the bottom-left corner there is a button to advance to the next turn. This will trigger each building to produce and consume their respective resources. Construction projects will advance and you might get a random event.

You only get 100 turns till the end of the game to build your army and prepare for the invasion.

Resource Panel

The panel in the top-left corner shows your current resources and how much you are producing and consuming. For the warriors and ships, a projection is shown to indicate how many you will have at the end of 100 turns assuming your current production rate stays the same. A resource will turn red if buildings are unable to produce because of a lack of that resource. This is a warning that you need to build more of that resource-producing building.

Crafting Dependencies

Production	Cost / Boost Buildings
	,
	,
	,

Credits

Programming

Ethan Anderson (Elan456)

Music

Written and composed by Love Springs

Art

Font: Oldenburg-Regular.ttf by Nicole Fally
Hammer Icon: 32x32 RPG Weapons Icons by AntrixGlow98
Tree Assets: Nature Trees by Admurin
Fire Animation: Pixel Fire by Elska
Wood Icon: Pixel Art Wood by Frostwindz
Ore Icon: 96 Total 32x32 Pixel Art Icons Ores Minerals Crystals by Ancient-Inscriptions
Food Icon: 180 Total 32x32 Pixel Art Icons Food Fruit Veggies Meat Candy Bread Etc by Ancient-Inscriptions
Axe Icon: 32x32 RPG Weapons Icons by AntrixGlow98
Warrior Icon: Viking by Dreamir
Ship Icon: Pixel Art Viking Ship 16 Directions by Helianthus-Games
Medieval Building Assets: Medieval Fantasy RPG Tileset by Ventilatore

Tooling

• Pygame for the game engine
• e-pyquadtree for the quadtree optimizations
• Tiled for the map editor
• GIMP for image editing
• Audacity for audio editing
• VS Code for code editing

Milestone Feature Breakdown

Final Project Milestone (11/21 - 12/9)

Notable Changes / Additions

1. Fix draw order of war power and villagers
2. Add an FPS counter
3. Add a proper caption and icon to the window
4. Fix the end game layers
5. Add a builder's hut help hint
6. Add icons to the README
7. Add procedurally generated clouds that move
8. Perlin noise background images
9. Fix deprived resource detection
10. Add a lore scroll
11. Fix leaves dropping at the wrong times
12. Change the river color to be more subtle
13. Add more int casting to prevent random.randint errors
14. Improve the paths / borders around the buildings
15. Put the building's icon on it's asset in the main screen, so it's easier to see what it is
16. Show the boost buildings when hovering over a building
17. Add a help screen (press H)
18. Add background music from Love Springs
19. Make the main resource panel much larger
20. Add red color when projection is less than the win condition

Milestone 3 (10/31 - 11/20)

Features Added (with Point Values Adding to 100)

1. Add construction phases to buildings (7)
2. Move the resource panel to the top-left (2)
3. Have the builders walk to construction sites (4)
4. Add a builder assignment manager (7)
5. Show how many turns are needed for a building to be completed to the hover panel (3)
6. Add a button to upgrade the wall and show the cost to do so (3)
7. Indicate buildings that are too expensive with a red rectangle (3)
8. Add an "along river" check for shipyards (3)
9. Improve the contrast of announcements (2)
10. Have the background color change with the seasons (5)
11. Add debris that float down the river and ripples to make the river more lively (5)
12. Add trees that grow over time and the lumberjacks navigate to them (6)
13. Advance the villagers by a few updates each turn to indicate the passage of time (4)
14. Add building demolition, requires turns just like construction (4)
15. Draw all the building assets (10)
16. Fix some resource consumption and production bugs (3)
17. Add a win condition prediction calculation, so the player knows if they are on track (5)
18. Render boats on the river as more are built (3)
19. Make the boats sway in the water (3)
20. Render soldiers in a box as the army grows (4)
21. Add a fire random event that destroys buildings (5)
22. Add plague, caravan, and blight random events (5)
23. Add descriptions to the buildings' hover panel (3)
24. Improve the Linux resolution (2)
25. Add a more stylized button (2)
26. Add a start screen with a button to start the game (3)
27. Add a win/lose screen with stats (2)
28. Navmesh optimizations using an additional quadtree (5)
29. Resource text changes color if it's over demanded (2)
30. Building panel shows icons for the buildings instead of the building itself (2)
31. Change disable, enable, and demolish buttons to be more stylied (2)

Milestone 2 (9/17 - 10/30)

Link to the full changelog

Features Added

• Random event skeleton
• Buttons
• Main panel (turn and resource display)
• Building panel (To drag and place buildings from)
• Building collision and placement
• Fully animated villagers (Idle + Walking)
• Villager pathfinding using A* algorithm, navigation mesh, and quadtree optimizations
• Ability to disable buildings
• Button to demolish buildings
• Placeholder building assets
• Full set of resource assets
• Resource production and consumption per building
• Resource production prediction algorithm
• Arrow key + WASD camera panning
• Middle-click + drag camera panning
• Villager speech bubbles
• Building definition file as a JSON with parsing
• Wall around the village