Skip to content

Latest commit

 

History

History
127 lines (95 loc) · 5.54 KB

README.md

File metadata and controls

127 lines (95 loc) · 5.54 KB
Raw

Shared Mod Resources

⚠ Important: Only include as is, do not modify shared resources in your mod. You risk breaking other mods otherwise.

Please open issues or create PRs in their respective repositories instead.

Shared Mods

  • shared-pools-and-definitions
    • Shared pools like "All Sand Mines" to allow multiple mods using the same new pools.
    • Construction menu helper
    • Hotel needs for compatibility with New World Tourism
    • Full documentation
  • shared-one-step-influence
    • Change guildhouse type influence into 20 times 1-base point instead of 1 time 20-based so that you can create e.g. 5 point buildings

Shared Mods in other Repositories

General

Products and Productions

  • Extra Goods: jakobharder/anno1800-shared-mods
    • Vegetables, Cheese, Tools, Hemp, Suits, Canned Fish, ...
  • Milk from Cattle Farms: lion053/shared-mods
    • Vanilla cattle farm pastures produce milk (Old and New World; if DLC12 is active New World is untouched)
  • Small Elevator Factory: lion053/shared-mods
    • To be able to use elevators as construction material even if Highlife-DLC is not owned / active.
  • Additional Products: Qurila/shared-mods
    • Products: Apples, Smoked Fish, Liqueur, Sandwiches, Wooden Jewelry, ...
    • Intermediate products: Cattle, Cherries, Barrels, Wool Fabric, Sewing Thread, ...
  • Vegetables Integration: Qurila/shared-mods
    • Replaces peppers with vegetables
  • Recipe Buildings: Qurila/shared-mods
    • Vanilla buildings converted into recipe buildings
  • Products and Productions: Drakkam/shared-mods
    • Products: Eggs, Bottles, Lenses, Fedora, Cameras, Ink, Marble Slabs, Marble Stones ...

Textures and Assets

How to use

Manual

Download a release, extract the mod you want into your own mod and add a the following dependency infos to your modinfo.json:

"ModDependencies": [
  "shared-pools-and-definitions"
],
"LoadAfterIds": [
  "shared-pools-and-definitions"
]

Automatic

Add a the following dependency infos to your modinfo.json and use the F1/right-click action Build and Deploy Mod of the Anno Modding Tools extension in VS Code.

"ModDependencies": [
  "https://github.com/anno-mods/shared-resources/releases/download/v7.1/shared-pools-and-definitions.zip"
],
"LoadAfterIds": [
  "shared-pools-and-definitions"
]

Contribution Guide

Shared mods in this repository may be used by many others. Strict rules are needed to not harm them:

  • No modifications that change vanilla gameplay.
  • Modifications that will be seen by all players (e.g. pools) have to include all translations.
  • Size should be kept as small as possible. Shared mods will be repeated in every Mod that is using it.
  • No modloader warnings.

If your shared mod follows different rules, is very big or only useful for a few then simply linking it in the above mods section may be the better choice.

Create a release

Make sure to update the version in modinfo.json!

All you need to do is to create a tag with the version and a v in front (e.g. v8.3). A draft release will be created for you.

Version scheme

vMAJOR.minor.path

  • MAJOR: increase when there's a new mod, or a new feature in pools-and-definition.
  • minor: increase when there are new pools, or other additions to existing features.
  • patch: increase when fixing bugs, translations

You can do that via browser

  • Go to Releases and click Draft a new release.
  • Enter the new version (e.g. v8.3 under Choose a tag).
  • Check Set as a pre-release to avoid the release being immediately public
  • Publish and wait until GitHub creates the assets and adds them
  • Publish the draft release created by GitHub

Or via console

git tag v8.3
git push --tags

And then publish the draft release created by GitHub.