From 729a9fd1ea3586f1ef132db367a3137a9f38c7f1 Mon Sep 17 00:00:00 2001 From: Gabriel Kaszewski Date: Sat, 23 Aug 2025 05:43:05 +0200 Subject: [PATCH] Add LICENSE and README files with project details and licensing information --- LICENSE.txt | 59 +++++++++++++++++++++++ README.md | 134 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 193 insertions(+) create mode 100644 LICENSE.txt create mode 100644 README.md diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..b548942 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,59 @@ +Parasitic God - License +This project uses a split licensing model. The source code is released into the public domain, while the art and audio assets are under a more restrictive license. + +Code License (The Unlicense) +This applies to all .cs, .gdshader, and other source code files. + +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +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 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. + +For more information, please refer to https://unlicense.org + +Asset License (All Rights Reserved) +This license applies to all files within the following directories and their subdirectories: + +/Sprites/ + +/Assets/ + +/Shaders/ (specifically the visual output, not the code) + +Any other directory containing visual (.png, .svg, .jpg, etc.) or audio (.wav, .ogg, .mp3, etc.) assets. + +The assets contained within this project are NOT covered by the code license above. They are the property of their respective creators. + +You are granted the following permissions: + +You MAY use these assets within the compiled, playable version of the game "Parasitic God". + +You MAY view and modify these assets on your local machine for the purpose of learning or personal enjoyment. + +You are explicitly forbidden from: + +Redistributing, sharing, or selling these assets in any form, either individually or as part of a collection. + +Using these assets in any other game, project, or work, commercial or non-commercial. + +Creating derivative works from these assets for public distribution. + +All rights to these assets are reserved by the original creators. If you wish to use them for any purpose not explicitly granted above, you must seek direct permission from the copyright holder. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..ce8b32d --- /dev/null +++ b/README.md @@ -0,0 +1,134 @@ +# Parasitic God +![Made With Godot](https://img.shields.io/badge/Made%20With-Godot-478CBF?style=for-the-badge&logo=godot-engine&logoColor=white) +![Lines of Code](https://tokei.rs/b1/github/GKaszewski/parasitic-god?style=for-the-badge&category=code) +![Last Commit](https://img.shields.io/github/last-commit/GKaszewski/parasitic-god?style=for-the-badge) +![Stars](https://img.shields.io/github/stars/GKaszewski/parasitic-god?style=for-the-badge) +## 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** + Watch a handful of followers grow into a massive civilization with huts, cities, and procedural road networks. + +* **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. + +* **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. + +### 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. + +* **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`. + +### 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: + +```json +{ + "name": "My Cool Miracle", + "faithCost": 100, + "followersRequired": 50, + "productionRequired": 0, + "unlockedByDefault": true, + "advancesToAge": "", + "effects": [ + { + "type": "AddResource", + "targetResource": "Faith", + "value": 200 + } + ] +} +``` + +### Available Effect Types + +This is the core of the modding system. Each miracle can have one or more effects. + +| 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. + +```json +{ + "tiers": [ + { + "tierEnum": "Tier1", + "threshold": 0, + "scenePath": "res://Scenes/Followers/followers_tier_1.tscn" + }, + { + "tierEnum": "Tier2", + "threshold": 200, + "scenePath": "res://Scenes/Followers/followers_tier_2.tscn" + } + ] +} +``` + +* **`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\! + +----- + +## 📊 Project Stats +📦 **Lines of Code:** +![Lines of code](https://tokei.rs/b1/github/GKaszewski/parasitic-god) + +📈 **Repo Activity:** +![Commit activity](https://img.shields.io/github/commit-activity/m/GKaszewski/parasitic-god) + +--- + +## License + +This project is open source. See the [LICENSE](https://www.google.com/search?q=./LICENSE) file for details. + +----- + +## Contributing + +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\! \ No newline at end of file