VS Village

Do NOT send a PR without speaking to MiraLeaps FIRST.

If you want to help out with code, please talk to me. If you send me a PR without talking about what's going on first, it will be rejected. If you send an AI generated PR with 'fixes', it will be rejected. If you have a BUG or and ISSUE report it through NORMAL means. If you are just looking to contribute to the wellbeing and expansion of this mod....talk to me first. I welcome help on things, but coordinate WITH ME. This has happened twice now, and both times the people submitting the PR did not take the time to actually understand the codebase before doing a drive-by PRing. This wastes my time because I have to look and then respond and then deal with it. If you find an actual issue in the mod while you are playing and you want to take a crack at fixing it, great....do a bug report and in that bug report tell me how you figure out how to fix it and show me your work. The unfortunate reality of the times we are living in is that people who do not understand good code practice are firing these things off and then can't really come to back up the changes themselves. That's not a contribution. I was granted stewardship over this mod and I take that very seroiusly. I put hours of work into testing and all that....respect that.

Summary

This mod adds villages and their inhabitants to your Vintage Story playthroughs. You can found your very own villages and watch its inhabitants follow their daily routines. If you install an extension for village generation (or create your own for that matter), it will even generate villages into your world. 

NOTICE:

If you are having an issue with a Village Addon-on Mod (Towers, Viking Villages, Simple, etc), unless there is a logged exception or a crash that names this mod in the error, please report those issues on the addon's page, not this one. We can't do much of anything about issues with those mods, such as Villagers not spawning. Make sure you are using the addon mods updated to the current version of the game!

Features

Founding Villages

Villager Types:

• Farmer: Farmers provide food for the village. Their daily routine is to tend to the fields nearby their workstations. They will make sure the crops are watered and cultivated. Cultivation can make crops grow much faster than ususal, but it requires a lot of work, so not many crops can be cultivated at a time.
• Shepherd: Shepherds tend to the animals of a village which also provides food. Their daily routine is to check on the animals and place feed into any troughs near their workstations.
• Herbalist: Herbalists are healers. They will buy foraged things from you, which they will make into things like healing items and candels for you to purchase. If you get hurt, you can visit the Herbalist and they will care for you.
• Smith: The hardworking Smiths spends their day forging metal items. You can sell them Ingots you smelt and they will craft toolheads which you can purchase.
• Soldier: Soldiers patrol and guard the village. They will spend their day checking in with the villagers and watching after things. If they see a threat, they will respond!
• Archer: Archers are soldiers who focus on protecting from range (Or they are supposed to, this is a bit bugged RN).
• Trader: The village Trader ensures you are stocked up on all the things you need to keep a village going. They will buy various things from you as you go.
• Builder: The Builder can be hired to build structures for you, for a cost!
• Mayor: (Not able to be hired) Mayors can be found in other villages you might run into around the world (if you have a village extension installed). They run their villages and see to matters of infrastruture and support.

Village Fixtures:

• Mayor Workstation: This should be your first purchase when you summon the Settlement Keeper! This allows you to manage your village. Make sure you place it near the center of your village lands! When you first interact with the station, you can name and set the radius for your village (100 is a recommended start), then you can see the statistics. Once you've named the village, it is now established and you can start placing Workstations, Braziers, Wapoint posts, and Beds! When you place your first Villager Bed (in a nice safe place!) and Workstation (I recommend hiring a Farmer first!), then you can hire your first villager! Hiring Villagers requires having enough food coming in from Farmers and Shepherds, so those should be your first picks. At any time (especially if they are bugged) you can dimiss a villager and they will leave (despawn).
• Brazier: The Brazier is a gathering point where your villagers can relax and be social after a hard day of work. Essential for their ongoing happiness!
• Villager Bed: Villagers need somewhere to sleep, these beds can be purchased from the Village Trader as only they can source the unique materials which the villagers need for a good night's sleep.
• Villager Workstation: Each type of villager has a workstation. You will want to place these near the areas where they will work. You can set up a shop for your trader, a workshop for you Smith, and a Apothecary for you Herbalist. Farmers and Shepherds need their stations near to the fields and animals. All centralized on the Mayor station which will server as thier morning check-in area. Soldier stations can be set up near the center too, or at checkpoints as you like.
• Waypoint Post: These work like street-signs in larger villages to help keep your villagers from getting lost and give them the ability to confidently find their way on longer walks.
• Market Stall: This struture attracts Travelling Traders to your village!

How to build a proper Room for your Villagers:

Currently, in order for a space to pass a check for things like a Villager's Bed, the space must be closed in properly. This means solid walls, with a door and no open-spaces (chimney's need trapdoors to seal them). Windows qualify, but are optional. Chiseled blocks can cause issues (we'll come back to those). The check for this to work relies on the base-game 'Is-this-a-room' mechanic; if another mod is modifying this check, it could also cause issues (please keep that in mind when making reports). Usually, if you get the "indoors" status on your character sheet, the room should be good to go.

If you've got a bed placed in a room and it still says its not properly placed try the following:

1. Are there any Chiseled Blocks as walls? If so, remove them temporarily and replace them with other blocks for now. When the check is passed, you can replace them. Chiseled Block Retention mod -should- make these pass if you use it, but this is untested.
2. Are you using a Crude Door? These do not actually enclose the room and will fail the check.
3. Is the space larger than 7x7x7? This will also fail a check.
4. Try using the debug command /debug rooms hi. This will give you an overlay or a fail-state. If the overlay is green, the room passes. If red, the room is semi-recongnized but not passing the check. Otherwise you might get the message "no room detected" (or something like that). If green, the bed placement should work. To remove the overlay, use /debug rooms unhi
5. If the rooms check comes back green and the bed STILL is not placing, make sure you have no other beds placed down other than those already taken by villagers. The villagers grab the beds nearest their viable workstations, so if another bed is down, even in a temp position, it could be the culprit. Also, it could be the case of having 'ghost' structures from if there were things copied in or spawned in or things removed via world edit tools that leave lingering registrations. Check to see if your bed count on your mayor station is accurate. If not, pick up the unowned bed (or beds) you are trying to get working, then look for any remaining beds that have no villagers and you can hit the remove structure button. This should clear them from your village and let that function. This is a super rare case to happen.
6. If none of that is working, put in a bug-report! (make sure you tag MiraLeaps!

TIps:

• Villagers work best with easy to navigate areas. They will go up and down stairs, and make their way around and through most stuff, but the clearer the path, the happier they are.
• Villagers prefer when their beds are indoors. You don't have to build them a house, but that is an option!
• The Mayor station is best at the center of the village. The Mayor station is the center point when you create the village. If you set it to 100, then 100 blocks from that station will count as part of the village. Villagers use it to get a start on navigating too.
• Villager shops for those that stick near their workstations like the trader, smith, and herbalist, need some room to breathe. You can put them against a wall, but the room itself works well at around 5x5 blocks with a roof.
• The Brazier needs a nice open area outside for everyone to gather up, especially if you get a large population. You can buy multiple and the Villagers will go to the nearest if you need to keep them split up for some reason.

Villager Quirks

• Villagers can get 'stuck' in place sometimes. Don't worry, they are probably just lost in thought or having a standing nap, or disassociating.....the world is broken and that can weigh heavy, just give them time and they'll catch up.
• Villagers sometimes want to cuddle up at night. Randomly, if beds are close by, villagers might shift and cuddle with other villagers. This is a perfectly normal cultural thing. (And a silly bug)
• Villagers sometimes sleep....walk. Much like the random cuddling, sometimes villagers will be so drawn to their work you might find them scooting along the ground at night, heading for the fields. They yern for the fields. Don't worry too much, they'll be fine. (another silly little bug. Both are rare but happen)
• If at any time a villager is just completely refusing to work, you can dismiss them. It is sad to see them go, but sometimes things happen.
• Check your Mayor Station if a Villager is stuck for too long, especially if they are stuck somewhere other than bed, they might have decided to leave the village without saying (rare rare bug, but happens)

NOTICE: Villagers can have issues with modded doors. Depending on the naming convention used by the mod maker in the mod, the doors could work perfectly or fail miserably. If you are having trouble with your villagers pathing through gates and doors, try switching them out for vanilla versions and see if that helps!

Interacting with villagers

Most villagers will follow simple daily routines. They will try to look busy at their workstation during the day, chill at the fireplace sold by the trader during the evening and sleep in their beds during the night.

If you have VS Quest installed, you can interact with your villagers to accept and complete quests for a variety of different rewards. 

Village Generation

Config Options:

• VillageChance: This is the chance that a village will spawn when a village addon is loaded with the mod. .5 is = to around 500% the intended spawning value.
• WorldGenBufferBlocks: this is the amount of 'buffer' villages that spawn in will get between them and story-locations at a minimum (includes traders).
• ChiseledBlocksCountAsWalls: If set to true, this turns on our version of Chiseld Block Retention (A lighter version of the standalone mod) so that Chiseled Blocks count as rooms for Villager Hiring

RoadMap:

Copying Villages Via World-Edit:

Warning: If you copy your villages via world-edit tools, ensure that no villagers or Workstations/beds/other present when you do so. Their ownership will not transfer and you can wind up with 'orphaned' Villagers and 'ghost' workstations. For the workstations/beds/other you can break them as you would to move other blocks and put them in a chest to copy them over without having to buy them again. There are some new buttons in the Mayor's station that can mark workstations as invalid, and check for orphaned villagers and despawn them.

Contribute

Translations

If you want to help translate the mod into your language, head over to the Crowdin Project to upload your community translation. I use a small script that automatically downloads the translations before every new release.

Features Requests:

If there is a feature that you are desperately missing just drop us a comment here and we'll get back to you as soon as possible!

Thanks to the ever wonderful Emeralddragons for the lovely new village photos :)

BUG REPORT NOTICE:

If you are coming to report a bug or issue with the mod, it is REQUIRED that you provide your SERVER-MAIN.log from the game session in which you encoutered the issues. Without Logs, We can only take broad guesses based on your reports, and that usually isn't helpful. If you report an issue without including the log, the post will not be followed up on.

How to find your logs and post them:

You will first need to navigate over to your Vintage Story Data Folder (not the Install Folder).

Typically it is found (on windows): C:\Users\<username>\AppData\Roaming\VintagestoryData (replace C: with the drive letter the data folder is found)

This is where you had to install your Mods, but if you had them installed via server join you might not know where this is.

In this directory you will see a Folder named Logs, and within this folder you will see a few .log files.

The file that we need is the server-main file. If the observed issue was during a previous session, look in the Archive folder and find the date/time closest to when you remember the incident occuring.

From this point, you have two options: you can reach out on Discord in the VSvillage channel (linked above) and upload your log there -or- you can upload the log to a hosting site and link it in the comments below. If you use GitHub, you can post the issues there using the issue tracker, it has log upload options as well.

If you comment here, please tag MiraLeaps so that your report can be handled as fast as possible. Please add a description of the issue with as much detail as reasonable and that you can remember and describe. If you need to write it in another language so that you can capture the details naturally, I will use google translate and follow-up on things that were maybe lost in the translation.

Please leave any commentary or opinion out of this context, especially if you have a bad attitude about it.

I usually respond to reports with tags within half a day or so, but please be patient

Personal Note: Mod makers work pretty tirelessly to keep the mods you love working at a quality you expect, the least you can do is work with us by reading existing documentation such as what is presented here. I, MiraLeaps, am setting a boundary on this that is in respect for my time and energy. I am a mom with a family and a job. This is my spare time hobby. I love making mods, I love helping people out with those and other mods, and I love making sure the mods I work on are performing the best they can...but I also love spending time with my family, actually playing games, and doing other stuff besides bug hunting. Bug hunting can take hours of effort. It can be stressful. Please, if you like these mods, help the hardworking modders out by providing logs, accurate reports, and by searching around the existing comments to see if the issues were talked about already. This isn't an indictment of anyone, and its not written in anger: I just have to set a boundary here if I am going to keep up working on this and my other projects.

Note on Errors:

If you are seing things in your logs that look like this regarding villagers:

These are NOT our villagers. These are Villagers from the base game story Village.