Skip to content

Add MIT License and Improve Documentation #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Zaykus wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add MIT License and Improve Documentation #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32e90d6
Create LICENSE
Zaykus Jun 15, 2025
17fcbfe
Update Readme.md
Zaykus Jun 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Zaykus

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
116 changes: 60 additions & 56 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,54 +6,57 @@ It's supported CO-OP and ONLINE modes now!

Both `IL2CPP` and `Mono` versions of the game are now supported!

* [BetterPayableUpgrade](https://github.com/abevol/KingdomMod#betterpayableupgrade)
* [DevTools](https://github.com/abevol/KingdomMod#devtools)
* [OverlayMap](https://github.com/abevol/KingdomMod#overlaymap)
* [StaminaBar](https://github.com/abevol/KingdomMod#staminabar)
* [BetterPayableUpgrade](#betterpayableupgrade)
* [DevTools](#devtools)
* [OverlayMap](#overlaymap)
* [StaminaBar](#staminabar)

## Preview

![Preview](https://github.com/abevol/KingdomMod/blob/master/preview.png?raw=true)

## Supported languages
## Supported Languages

1. [中文](https://github.com/abevol/KingdomMod/blob/master/Readme.zh-CN.md)
2. [English](https://github.com/abevol/KingdomMod/blob/master/Readme.md)

## Install

1. First determine whether your game version is `IL2CPP`, or the`Mono` version.
* `IL2CPP` version, the game directory contains the folder `KingdomTwoCrowns_Data\il2cpp_data`
* `Mono` version, the game directory contains the folder `KingdomTwoCrowns_Data\Managed`
2. According to your game version, download the mod loader of a specific version. Unzip all files to the root directory of the game, and ensure that the `BepInEx` folder and `winhttp.dll` file are in the same directory with the game main program `KingdomTwoCrowns.exe`.
* `IL2CPP` version, download [BepInEx-Unity.IL2CPP-win-x64-6.0.0-be.735](https://builds.bepinex.dev/projects/bepinex_be/735/BepInEx-Unity.IL2CPP-win-x64-6.0.0-be.735%2B5fef357.zip)
* Due to incompatibility caused by game updates, for `IL2CPP` version you also need to download [Cpp2IL.Patch](https://github.com/abevol/KingdomMod/releases/download/2.4.0/Cpp2IL.Patch.zip), extract it to the game root directory, and overwrite the files with the same name in the BepInEx mod loader.
* `Mono` version, download [BepInEx-Unity.Mono-win-x64-6.0.0-be.735](https://builds.bepinex.dev/projects/bepinex_be/735/BepInEx-Unity.Mono-win-x64-6.0.0-be.735%2B5fef357.zip)
3. Download the mod of a specific version according to your game version. Download the mod file from [Releases](https://github.com/abevol/KingdomMod/releases), unzip all files to the directory `Kingdom Two Crowns\BepInEx\plugins`.
* `IL2CPP` version, download mods with `BIE6_IL2CPP` in the file name.
* `Mono` version, download mods with `BIE6_Mono` in the file name.
4. Now mods are installed. After starting the game, mods can be automatically loaded.
1. First determine whether your game version is `IL2CPP` or the `Mono` version.
* `IL2CPP` version: the game directory contains the folder `KingdomTwoCrowns_Data\il2cpp_data`
* `Mono` version: the game directory contains the folder `KingdomTwoCrowns_Data\Managed`

2. According to your game version, download the mod loader of the specific version. Unzip all files to the root directory of the game, and ensure that the `BepInEx` folder and `winhttp.dll` file are in the same directory as the game main program `KingdomTwoCrowns.exe`.
* `IL2CPP` version: download [BepInEx-Unity.IL2CPP-win-x64-6.0.0-be.735](https://builds.bepinex.dev/projects/bepinex_be/735/BepInEx-Unity.IL2CPP-win-x64-6.0.0-be.735%2B5fef357.zip)
* Due to incompatibility caused by game updates, for the `IL2CPP` version you also need to download [Cpp2IL.Patch](https://github.com/abevol/KingdomMod/releases/download/2.4.0/Cpp2IL.Patch.zip), extract it to the game root directory, and overwrite the files with the same name in the BepInEx mod loader.
* `Mono` version: download [BepInEx-Unity.Mono-win-x64-6.0.0-be.735](https://builds.bepinex.dev/projects/bepinex_be/735/BepInEx-Unity.Mono-win-x64-6.0.0-be.735%2B5fef357.zip)

3. Download the mod of the specific version according to your game version. Download the mod file from [Releases](https://github.com/abevol/KingdomMod/releases), unzip all files to the directory `Kingdom Two Crowns\BepInEx\plugins`.
* `IL2CPP` version: download mods with `BIE6_IL2CPP` in the file name.
* `Mono` version: download mods with `BIE6_Mono` in the file name.

4. Now mods are installed. After starting the game, mods will be automatically loaded.

## BetterPayableUpgrade

Better pay for upgrades. Adjusted the price of some payable upgrade objects in the game, the objects of the next level and the construction time to make them more reasonable and comfortable.

### Adjust details
### Adjustment Details

* Reduced the size of the coin, now your coin bag can hold more coins (about 100).

| Level | Name | Upgrade Price | Build Time |
|-----|------|---------|----------|
|0|monolith|3 => 2|-|
|1 |Rock Platform -| 6 => - | 30 => - |
|2 |Wooden Watchtower| 9 => 5 | 60 => 30|
|3 |Stone Tower| 12 => 8 | 90 => 50|
|4 |Triple Tower -| 15 => - | 120 => - |
|5 | triple tower with roof | 18 => 12 | 150 => 80 |
|6 |Four Towers| 18 => 16 | 180 => 120|
|- |Citizen Home Recruitment| 5 => 3 |- |
|- |Craft Oil Barrel| 5 => 3 |-|
|- |making bread| 4 => 2 |-|
|-------|------|---------------|------------|
| 0 | Monolith | 3 => 2 | - |
| 1 | Rock Platform | 6 => - | 30 => - |
| 2 | Wooden Watchtower | 9 => 5 | 60 => 30 |
| 3 | Stone Tower | 12 => 8 | 90 => 50 |
| 4 | Triple Tower | 15 => - | 120 => - |
| 5 | Triple Tower with Roof | 18 => 12 | 150 => 80 |
| 6 | Four Towers | 18 => 16 | 180 => 120 |
| - | Citizen Home Recruitment | 5 => 3 | - |
| - | Craft Oil Barrel | 5 => 3 | - |
| - | Making Bread | 4 => 2 | - |

* `-` means unavailable or removed.
* All modes and DLC are now supported.
Expand All @@ -70,59 +73,60 @@ Developer tools mod. Contains some functions that are convenient for making MODs
### Hotkeys

1. `Ctrl + D` Enable DevTools
2. `Home` Displays debug information
3. `End` Displays objects information
4. `Insert` Tests some interesting features
5. `X` Dumps game objects to JSON file
2. `Home` Display debug information
3. `End` Display objects information
4. `Insert` Test some interesting features
5. `X` Dump game objects to JSON file
6. `P` Print presets to console
7. `L` Prints the level module to the console
7. `L` Print the level module to the console
8. `Delete` Cut down the currently selected tree
9. `F1` Add vagrant
10. `F2` Add Griffin
11. `F9` Activate the Game Developer Debug Toolkit
12. `F10` Set coin limit to 1000
13. `Space` Throws a boulder
13. `Space` Throw a boulder

## OverlayMap

A map mod. It marks points of interest, along with some extra details. There's also the demographics feature, which tells you how many of each type there are.

## Features
### Features

1. Add a map floating layer on the top of the screen, and marks points of interest in the game on it, including castles, slums, docks, cliffs, etc.
2. By default, only the markers in the area you have explored are displayed, of course you can also show the full map immediately by pressing the `Ctrl + F` key (Not recommended).
3. Displays some useful stats, including the number of idle villagers, workers, archers, farmers and farmland.
1. Add a map floating layer on the top of the screen, and mark points of interest in the game on it, including castles, slums, docks, cliffs, etc.
2. By default, only the markers in the area you have explored are displayed. Of course, you can also show the full map immediately by pressing the `Ctrl + F` key (Not recommended).
3. Display some useful stats, including the number of idle villagers, workers, archers, farmers and farmland.
4. Display additional useful information, such as current time, current island, number of gems and coins, etc.
5. Some shortcut features, such as quick save or reload the game without exiting the game.
6. The progress of the exploring area now can be saved with the saving archive of the game.
6. The progress of the exploring area can now be saved with the game's save file.

## Hotkeys
### Hotkeys

1. `M` Display the map overlay
2. `Ctrl + F` Show the full map (Not recommended, it will reduce the fun of the game)
3. `F5` Reload saved game (without exiting game)
4. `F8` Save game (without exiting game)

## Signs and Colors
### Signs and Colors

| Signs or Colors | Meanings |
|----|----|
|`♜`|Castle|
|`۩`|Wall|
|`∧`|Dirt mound|
|`≈`|River|
|`♣`|Berry Bush|
|$\color{red}{Red}$|Not unlocked, not captured, wrecked|
|$\color{blue}{Blue}$|Under construction|
|$\color{green}{Green}$|Unlocked, safe|

### Custom style and language
|-----------------|----------|
| `♜` | Castle |
| `۩` | Wall |
| `∧` | Dirt mound |
| `≈` | River |
| `♣` | Berry Bush |
| $\color{red}{Red}$ | Not unlocked, not captured, wrecked |
| $\color{blue}{Blue}$ | Under construction |
| $\color{green}{Green}$ | Unlocked, safe |


### Custom Style and Language

Map mods now support custom styles and languages, and you can find their configuration files in the game directory `Kingdom Two Crowns\BepInEx\config`.

* `KingdomMod.OverlayMap.cfg`, configure the current language and style file name,
* `KingdomMod.OverlayMap.Style.cfg`, the style file of the map mod. You can modify the text color and marker symbols in it.
* `KingdomMod.OverlayMap.Language.en-US.cfg`, the language file of the map mod. You can use this file as a template to make your native language files. Copy the file, change the `en-US` part of the file name to the language code of your own country, such as `KingdomMod.OverlayMap.Language.ru-RU.cfg`, and then localize the strings in the file translate.
* `KingdomMod.OverlayMap.cfg` - configure the current language and style file name
* `KingdomMod.OverlayMap.Style.cfg` - the style file of the map mod. You can modify the text color and marker symbols in it.
* `KingdomMod.OverlayMap.Language.en-US.cfg` - the language file of the map mod. You can use this file as a template to make your native language files. Copy the file, change the `en-US` part of the file name to the language code of your own country, such as `KingdomMod.OverlayMap.Language.ru-RU.cfg`, and then localize the strings in the file by translating them.
* Welcome to share your language and style files: [Share Entry](https://github.com/abevol/KingdomMod/issues/3).

## StaminaBar
Expand All @@ -141,4 +145,4 @@ Stamina bar mod. It visually shows the stamina value of the mount by drawing a v

### Hotkeys

1. `N` show/hide stamina bar
1. `N` Show/hide stamina bar