|
|
|
|
@@ -1,52 +1,65 @@
|
|
|
|
|
# Parasitic God
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## The Concept
|
|
|
|
|
|
|
|
|
|
You are a nascent god, tethered to a small tribe of followers on a vibrant, living world. Their worship is your lifeblood, their growth your only purpose. You grant them miracles, blessing them with bountiful harvests and inspiring great works.
|
|
|
|
|
|
|
|
|
|
But your power comes at a cost. Every miracle that nurtures your civilization also poisons the planet. The soil turns barren, the forests wither, and the sky darkens. You are their savior and their apocalypse.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## The Mission
|
|
|
|
|
|
|
|
|
|
Guide your people from a simple tribe to a star-faring civilization capable of escaping the dying world. Manage your resources **Faith**, **Followers**, and **Production** while trying to keep the planet's ever-rising **Corruption** at bay.
|
|
|
|
|
|
|
|
|
|
Unlock new ages of technology, build a network of cities, and perform the final, desperate miracle to launch your followers into the stars before you consume everything.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
* **Exponential Growth**
|
|
|
|
|
|
|
|
|
|
- **Exponential Growth**
|
|
|
|
|
Watch a handful of followers grow into a massive civilization with huts, cities, and procedural road networks.
|
|
|
|
|
|
|
|
|
|
* **A World That Reacts**
|
|
|
|
|
- **A World That Reacts**
|
|
|
|
|
See the direct consequences of your actions as the vibrant globe fades to a corrupted wasteland and forests vanish based on your decisions.
|
|
|
|
|
|
|
|
|
|
* **Deeply Moddable**
|
|
|
|
|
The entire game from miracles and their effects to the visual tiers of your civilization is driven by simple JSON files. If you can edit a text file, you can mod this game.
|
|
|
|
|
- **Deeply Moddable**
|
|
|
|
|
The entire game—from miracles and their effects to the visual tiers of your civilization—is driven by simple JSON files. If you can edit a text file, you can mod this game.
|
|
|
|
|
|
|
|
|
|
* **Strategic Resource Management**
|
|
|
|
|
- **Strategic Resource Management**
|
|
|
|
|
Balance the generation of multiple resources and make difficult choices. Will you sacrifice followers to purge corruption, or push for industrial growth at any cost?
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Modding Your Universe
|
|
|
|
|
|
|
|
|
|
This game was built from the ground up to be modified. You can add new miracles, change existing ones, and even define new visual tiers for your civilization.
|
|
|
|
|
This game was built from the ground up to be modified. You can add new miracles, create random events, and even define new visual tiers for your civilization.
|
|
|
|
|
|
|
|
|
|
### Finding the Mods Folder
|
|
|
|
|
|
|
|
|
|
First, you need to find the game's `user data` directory. The game will create a `Mods` folder here on its first launch.
|
|
|
|
|
The game creates a `Mods` folder in its user data directory on first launch:
|
|
|
|
|
|
|
|
|
|
* **Windows:** `%APPDATA%\Godot\app_userdata\ParasiticGod\Mods\`
|
|
|
|
|
* **macOS:** `~/Library/Application Support/Godot/app_userdata/ParasiticGod/Mods/`
|
|
|
|
|
* **Linux:** `~/.local/share/godot/app_userdata/ParasiticGod/Mods/`
|
|
|
|
|
- **Windows:** `%APPDATA%\Godot\app_userdata\ParasiticGod\Mods\`
|
|
|
|
|
- **macOS:** `~/Library/Application Support/Godot/app_userdata/ParasiticGod/Mods/`
|
|
|
|
|
- **Linux:** `~/.local/share/godot/app_userdata/ParasiticGod/Mods/`
|
|
|
|
|
|
|
|
|
|
Inside, you'll find two folders: `Miracles` and `Tiers`.
|
|
|
|
|
Inside, you'll find three folders: `Miracles`, `Tiers`, and `Events`.
|
|
|
|
|
The game also loads a set of base mods from its installation directory (`res://Mods`). Any files you place in the user folder will be added to or override the base game's content.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### Creating a New Miracle
|
|
|
|
|
|
|
|
|
|
To add a new miracle, simply create a new `.json` file in the `Mods/Miracles` folder. The filename will be its unique **ID** (e.g., `my_cool_miracle.json`).
|
|
|
|
|
|
|
|
|
|
Here is a template with all available fields:
|
|
|
|
|
To add a new miracle, create a JSON file in `Mods/Miracles`.
|
|
|
|
|
The filename becomes its unique **ID** (e.g., `my_cool_miracle.json`):
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
@@ -55,7 +68,7 @@ Here is a template with all available fields:
|
|
|
|
|
"followersRequired": 50,
|
|
|
|
|
"productionRequired": 0,
|
|
|
|
|
"unlockedByDefault": true,
|
|
|
|
|
"advancesToAge": "",
|
|
|
|
|
"advancesToAge": "The Cool Age",
|
|
|
|
|
"effects": [
|
|
|
|
|
{
|
|
|
|
|
"type": "AddResource",
|
|
|
|
|
@@ -64,28 +77,46 @@ Here is a template with all available fields:
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### Creating a New Event
|
|
|
|
|
|
|
|
|
|
To add a new random event, create a JSON file in `Mods/Events`:
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"id": "event_my_event",
|
|
|
|
|
"title": "A Thing Happened!",
|
|
|
|
|
"description": "Something unexpected occurred. What will you do?",
|
|
|
|
|
"meanTimeToHappen": 120,
|
|
|
|
|
"trigger": {
|
|
|
|
|
"minFollowers": 100,
|
|
|
|
|
"maxCorruption": 50
|
|
|
|
|
},
|
|
|
|
|
"options": [
|
|
|
|
|
{
|
|
|
|
|
"text": "Do the thing!",
|
|
|
|
|
"tooltip": "Gain 50 Production.",
|
|
|
|
|
"effects": [
|
|
|
|
|
{
|
|
|
|
|
"type": "AddResource",
|
|
|
|
|
"targetResource": "Production",
|
|
|
|
|
"value": 50
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Available Effect Types
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
This is the core of the modding system. Each miracle can have one or more effects.
|
|
|
|
|
### Modifying Visual Tiers
|
|
|
|
|
|
|
|
|
|
| Type | Description | Parameters |
|
|
|
|
|
| :--- | :--- | :--- |
|
|
|
|
|
| **`AddResource`** | Adds or subtracts from a core stat. | `targetResource` (Stat), `value` (number) |
|
|
|
|
|
| **`ConvertResource`** | Trades one resource for another. | `fromResource` (Stat), `fromAmount` (number), `toResource` (Stat), `toAmount` (number) |
|
|
|
|
|
| **`ModifyStat`** | Permanently changes a passive stat. | `targetStat` (Stat), `op` ("Add" or "Multiply"), `value` (number) |
|
|
|
|
|
| **`ApplyBuff`** | Applies a temporary multiplier. | `targetStat` (Stat), `multiplier` (number), `duration` (seconds) |
|
|
|
|
|
| **`UnlockMiracle`** | Unlocks other miracles. | `miraclesToUnlock` (list of miracle IDs) |
|
|
|
|
|
| **`DestroySelf`** | Removes the miracle's button after use. | (No parameters) |
|
|
|
|
|
|
|
|
|
|
**Valid Stat Names:** `Faith`, `Followers`, `Corruption`, `Production`, `ProductionPerSecond`, `CorruptionPerSecond`, `FaithPerFollower`.
|
|
|
|
|
|
|
|
|
|
### Modifying Tiers
|
|
|
|
|
|
|
|
|
|
You can change the progression of visuals like followers and huts by editing the files in `Mods/Tiers`. For example, to change when followers get new looks, edit `follower_tiers.json`.
|
|
|
|
|
|
|
|
|
|
The format is a list of tiers, sorted by their threshold.
|
|
|
|
|
You can change the visual progression of followers, huts, and temples by editing the files in `Mods/Tiers`.
|
|
|
|
|
The format is a list of tiers, sorted by threshold:
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
@@ -93,37 +124,54 @@ The format is a list of tiers, sorted by their threshold.
|
|
|
|
|
{
|
|
|
|
|
"tierEnum": "Tier1",
|
|
|
|
|
"threshold": 0,
|
|
|
|
|
"scenePath": "res://Scenes/Followers/followers_tier_1.tscn"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"tierEnum": "Tier2",
|
|
|
|
|
"threshold": 200,
|
|
|
|
|
"scenePath": "res://Scenes/Followers/followers_tier_2.tscn"
|
|
|
|
|
"imagePath": "user://Mods/Tiers/Huts/my_custom_hut.png",
|
|
|
|
|
"scale": { "x": 1.0, "y": 1.0 }
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
* **`tierEnum`**: Must be one of `Tier1`, `Tier2`, `Tier3`, `Tier4`, `Tier5`.
|
|
|
|
|
* **`threshold`**: The number of followers (or other stat) needed to unlock this visual.
|
|
|
|
|
* **`scenePath`**: The path to the Godot scene (`.tscn`) to display for this tier. You can even point to your own custom scenes if you're an advanced modder\!
|
|
|
|
|
* **tierEnum**: Must be one of `Tier1` through `Tier10`.
|
|
|
|
|
* **threshold**: The number of followers needed to unlock this visual.
|
|
|
|
|
* **imagePath**: The path to the image file. Use `user://` for mods or `res://` for base assets.
|
|
|
|
|
* **scale**: Optional X/Y scale multiplier for the image.
|
|
|
|
|
|
|
|
|
|
-----
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## 📊 Project Stats
|
|
|
|
|
📦 **Lines of Code:**
|
|
|
|
|
### Available Effect Types
|
|
|
|
|
|
|
|
|
|
Both miracles and event options use this list of effects:
|
|
|
|
|
|
|
|
|
|
| Type | Description | Parameters |
|
|
|
|
|
| ------------------- | ----------------------------------- | ---------------------------------------------------------- |
|
|
|
|
|
| **AddResource** | Adds or subtracts from a core stat. | `targetResource` (Stat), `value` (number) |
|
|
|
|
|
| **ConvertResource** | Trades one resource for another. | `fromResource`, `fromAmount`, `toResource`, `toAmount` |
|
|
|
|
|
| **ModifyStat** | Permanently changes a passive stat. | `targetStat`, `op` ("Add" or "Multiply"), `value` |
|
|
|
|
|
| **ApplyBuff** | Applies a temporary multiplier. | `buffId`, `targetStat`, `multiplier`, `duration` (seconds) |
|
|
|
|
|
| **UnlockMiracle** | Unlocks other miracles. | `miraclesToUnlock` (list of IDs) |
|
|
|
|
|
| **DestroySelf** | Removes the miracle's button. | (No parameters) |
|
|
|
|
|
| **Win** | Triggers the game's win condition. | (No parameters) |
|
|
|
|
|
|
|
|
|
|
**Valid Stat Names:**
|
|
|
|
|
`Faith`, `Followers`, `Corruption`, `Production`, `ProductionPerSecond`, `CorruptionPerSecond`, `FollowersPerSecond`, `FaithPerFollower`, `ProductionPerFollower`
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Project Stats
|
|
|
|
|
|
|
|
|
|
**Lines of Code:**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
📈 **Repo Activity:**
|
|
|
|
|
**Repo Activity:**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
This project is open source. See the [LICENSE](https://www.google.com/search?q=./LICENSE) file for details.
|
|
|
|
|
This project is open source. See the [LICENSE](./LICENSE.txt) file for details.
|
|
|
|
|
|
|
|
|
|
-----
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
@@ -131,4 +179,4 @@ While the core code is complete for the jam, you can help by:
|
|
|
|
|
|
|
|
|
|
* Reporting bugs or balance issues.
|
|
|
|
|
* Creating cool new miracles and sharing them.
|
|
|
|
|
* Spreading the word\!
|
|
|
|
|
* Spreading the word!
|
