Merge pull request #1 from etrusci-org/dev

Dev

LICENSE.md

@@ -1,3 +1,5 @@
 # Destiny's Path 4 - License
 
-Copyright arT2 (etrusci.org)
+Public Domain
+
+*Have more fun.*

README.md

@@ -0,0 +1,150 @@
+# Destiny's Path 4
+
+An idle game that is *played* in a terminal window. No input is required once it is running.
+
+It just exists for relaxation/learning reasons (same reason i never released part 1-3)... Enjoy!
+
+---
+
+
+
+
+## Dependecies
+
+- **[Python](https://www.python.org/downloads/) version `>= 3.9.2`**
+  - On Linux: It's most probably already installed. Otherwise install **python3** with your favorite package manager.
+  - On Windows / MacOS / Other: Download the latest `3.x.x` release and install it. Make sure to let the setup program *"add Python to your PATH"*.
+- A terminal to run it. The default on any platform should do the trick.
+
+**Note**: DP4 was written and tested on Python  `3.9.2`. Later Python versions may introduce breaking changes, but usually you're good with installing the latest one. You can have multiple Python versions installed at the same time.
+
+---
+
+
+
+
+## Install / Update
+
+1. [Download](https://github.com/etrusci-org/destinyspath4/releases) the latest release.
+2. Unpack the compressed release file and copy the **destinyspath4-x.x.x** directory to any place on your system.
+
+If you want to update to a new release, just repeat those steps and copy over the previous save files.
+
+---
+
+
+
+
+## Quickstart
+
+Open a terminal window and change into the `game/` directory:
+
+```bash
+cd path/to/destinyspath4/game/
+```
+
+Play the game:
+
+```bash
+# On *nix:
+./dp4.py --play
+# maybe you have to make it executable first with `chmod +x dp4.py`
+```
+
+
+```bash
+# On Windows systems:
+python3 dp4.py --play
+# or if `python3` does not work try...
+python.exe dp4.py --play
+# or
+C:/path/to/python3/python.exe dp4.py --play
+```
+
+Progress will be auto-saved from time to time or when you quit the game with `CTRL+C`.
+
+---
+
+
+
+
+## Usage
+
+You can use either the short or long arguments. E.g. `-p` and `--play` are the same.
+
+If you do not add any arguments, the following help text will be displayed:
+
+```text
+usage: dp4.py [-h] [-p] [-n NAME] [-d PATH]
+
+An idle game that is played in a terminal window. No input is required once it is running. 
+Auto-saves every 3.0 minutes. Press CTRL+C to save and quit.
+
+optional arguments:
+  -h, --help                   show this help message and exit
+  -p, --play                   play the game
+  -n NAME, --save-name NAME    name of the save game to create or resume from (default=save1)
+  -d PATH, --save-dir PATH     path to the save data directory (default=/path/to/destinyspath4/game/save)
+```
+
+---
+
+
+
+
+## Usage Examples
+
+**Get help**. Display the usage help:
+
+```bash
+dp4.py
+dp4.py --help
+dp4.py -h
+```
+
+**Play the game** - Start a new or resume a previous game if you played before using the default save data file name and directory:
+
+```bash
+dp4.py --play
+dp4.py -p
+```
+
+**Start or resume a game with another name** - The save data file will be named **myothergame**:
+
+```bash
+dp4.py --play --save-name myothergame
+dp4.py -p -n myothergame
+```
+
+**Use another save data file directory** - The save data files will be stored in **/path/to/mysavedata**:
+
+```bash
+dp4.py --play --save-dir /path/to/mysavedata
+dp4.py -p -d /path/to/mysavedata
+```
+
+**All arguments combined**:
+
+```bash
+dp4.py --play --save-name myothergame --save-dir /path/to/mysavedata
+dp4.py -p -n myothergame -d /path/to/mysavedata
+```
+
+---
+
+
+
+
+## Thanks
+
+Some asset text data was contributed by [orochihanma](https://twitch.tv/orochihanma) and [execratus](https://twitch.tv/exe_cratus) in:
+[object_name.dat](./game/asset/object_name.dat), [object_prefix.dat](./game/asset/object_prefix.dat) and [object_suffix.dat](./game/asset/object_suffix.dat)
+
+---
+
+
+
+
+## License
+
+Public Domain

game/asset/container_name.dat

@@ -0,0 +1,5 @@
+barrel
+box
+casket
+coffer
+crate

game/asset/deathcause_text.dat

@@ -0,0 +1,24 @@
+a cosmic anomaly erased you from existence
+a crazy cow overrun you
+a deadly booby trap caught you off guard
+a deadly virus outbreak
+a freak accident involving a malfunctioning robot
+a genetically mutated creature attacked you
+a inexplicable time loop trapped you
+a malevolent spirit possessed you
+a poisonous plant poisoned you
+a rogue artificial intelligence targeted you
+a sinkhole swallowed you up
+an encounter with a rabid animal
+an meteorite collision
+of a deadly earthquake
+some random sniper shot you
+you drowned in a flash flood
+you fell into a deep chasm
+you were ambushed by a pack of feral creatures
+you were caught in a volcanic eruption
+you were consumed by an otherworldly void
+you were devoured by a mythical creature
+you were engulfed by a wildfire
+you were entangled in an impenetrable web of dark magic
+you were struck by a lightning bolt