Merge pull request #39 from cyb3rpsych0s1s/chore/book-cleanup

Chore/book cleanup

.gitignore

@@ -15,3 +15,4 @@ archive/packed/
 .installation/
 dump.redscripts
 *.env
+medium/

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# How to ?
+
+Hi! I'd love to have your contributions!
+
+## 🐛 Bugs report
+
+Testing game mods is time-consuming so you might not realize it, but a good way to support this mod is simply to report any bug found by simply filing a [Github issue](https://github.com/cyb3rpsych0s1s/4ddicted/issues).
+
+## 💡 Suggestions
+
+If you want to suggest a feature, please open a [Github Discussion](https://github.com/cyb3rpsych0s1s/4ddicted/discussions) and let's talk about it!
+
+I'm welcome to suggestions as long as they match with my own vision of the mod: being lore-friendly and immersive.
+
+> Also I'm doing this on my free time without any retribution, so be respectful of my time and temper your expectations :)
+
+## 🧑‍💻 Contribute
+
+If you want to contribute: everything from setting up your dev environment and more is already described in the [book](https://cyb3rpsych0s1s.github.io/4ddicted/)! See *Installation*, *Manifest* and *CLI* sections.
+
+The contribution process is the same as for any other repositories:
+
+- fork this repo
+- create a new branch
+- commit your changes
+- open a PR on this repo from your fork
+
+If you have any question, please reach out to me [in Discord](https://discordapp.com/users/610210802426707991) and introduce yourself :)

LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2023 Romain Kelifa
+
+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.

README.md

@@ -1,52 +1,11 @@
 # Addicted
 
-![build](https://github.com/cyb3rpsych0s1s/4ddicted/actions/workflows/quality.yml/badge.svg) ![book](https://github.com/cyb3rpsych0s1s/4ddicted/actions/workflows/pages.yml/badge.svg)
+[![build](https://github.com/cyb3rpsych0s1s/4ddicted/actions/workflows/quality.yml/badge.svg)](https://github.com/cyb3rpsych0s1s/4ddicted/actions) [![book](https://github.com/cyb3rpsych0s1s/4ddicted/actions/workflows/pages.yml/badge.svg)](https://cyb3rpsych0s1s.github.io/4ddicted/) ![download](https://img.shields.io/github/v/release/cyb3rpsych0s1s/4ddicted?display_name=tag&include_prereleases&label=Download)
 
-An amplifier mod based on core game consumables, and optionally on community mods `Toxicity` (not yet compatible with `WE3D - Drugs in Night City`).
+An amplifier mod for [Cyberpunk 2077](https://www.cyberpunk.net/) based on core game consumables.
 
-Basically adds a chance to become addicted to substances too frequently consumed, like MAXdoc and the likes, offering additional debuffs and effects in an immersive way.
+## description
 
-## Play
+Basically adds a chance to become addicted to consumables too frequently consumed, like MAXdoc and the likes, offering additional debuffs and effects in an immersive way.
 
-Just download the latest release and install like any other mod.
-
-## Contribute
-
-To ease development, a `justfile` is available with the following commands:
-
-- first, install [Just](https://just.systems/man/en/chapter_4.html?highlight=brew#packages)
-- then you can list all available commands:
-
-  ```sh
-  just
-  ```
-
-- generally speaking, while coding you will most likely be interested in these commands:
-  - run once on install, to create folders if missing
-
-    ```sh
-    just setup
-    ```
-
-  - copy files to game dir *before launching game*:
-
-    ```sh
-    just build
-    ```
-
-  - copy files to game dir *while game is running* (excluding `archive`, see below):
-
-    ```sh
-    just rebuild
-    ```
-
-### ℹ️ Coding process
-
-1. build:
-   - `archive` can only be reloaded from Wolvenkit GUI's Hot Reload (RED Hot Tools required) while game is running.
-   - `tweaks`, `scripts` and `mods` can be just copied over to game files.
-2. refresh:
-   - once done, click in CET console:`archive` for WolvenKit archive, TweakXL `tweaks`, REDscript `scripts` and CET `reload all mods`
-3. remember that depending on what you changed reloading a save is necessary, or the game itself sometimes.
-
-A lot more informations can be found in the [book](https://cyb3rpsych0s1s.github.io/4ddicted).
+A lot more informations can be found in the [book](https://cyb3rpsych0s1s.github.io/4ddicted/).

justfile

@@ -141,7 +141,7 @@ read:
 
 # 🖊️  book with live hot reload
 draft:
-    mdbook watch
+    mdbook watch --open
 
 # 📕 assemble book (for release in CI)
 assemble:

pages/SUMMARY.md

@@ -1,25 +1,28 @@
 # Summary
 
+Welcome to Addicted notebook !
+
 ## Contribute / Learn
 
 - [Install](./install.md)
+- [Manifest](./manifest.md)
+- [CLI](./cli.md)
 - [Wiki](./wiki.md)
-- [Cheatsheet](./cheatsheet/summary.md)
-  - [primitives](./cheatsheet/primitives.md)
-  - [sounds](./cheatsheet/sounds.md)
-  - [custom icons](./cheatsheet/icons.md)
-- [Patterns](./patterns/summary.md)
-  - [Systems](./patterns/systems.md)
-  - [Callbacks](./patterns/callbacks.md)
-  - [Events](./patterns/events.md)
-  - [Blackboards](./patterns/blackboards.md)
-  - [StatListeners](./patterns/statlisteners.md)
-  - [Effectors](./patterns/effectors.md)
-- [Troubleshooting](./troubleshooting.md)
+  - [Cheatsheet](./cheatsheet/summary.md)
+    - [primitives](./cheatsheet/primitives.md)
+    - [sounds](./cheatsheet/sounds.md)
+    - [custom icons](./cheatsheet/icons.md)
+  - [Patterns](./patterns/summary.md)
+    - [Systems](./patterns/systems.md)
+    - [Callbacks](./patterns/callbacks.md)
+    - [Events](./patterns/events.md)
+    - [Blackboards](./patterns/blackboards.md)
+    - [Listeners](./patterns/listeners.md)
+    - [Effectors](./patterns/effectors.md)
+  - [Troubleshooting](./troubleshooting.md)
 
 ## Archives
 
-- [Game infos](./info.md)
 - [Travelog](./travelog/summary.md)
   - [2023-01-21](./travelog/2023-01-21.md)
   - [2023-01-22](./travelog/2023-01-22.md)
@@ -28,5 +31,9 @@
   - [2023-01-27](./travelog/2023-01-27.md)
   - [2023-01-29](./travelog/2023-01-29.md)
   - [2023-01-30](./travelog/2023-01-30.md)
-- [Initial concept](./concept.md)
-- [Handbook notes](./notes.md)
+  - [2023-01-31](./travelog/2023-01-31.md)
+  - [2023-02-03](./travelog/2023-02-03.md)
+  - [2023-02-04](./travelog/2023-02-04.md)
+  - [2023-02-06](./travelog/2023-02-06.md)
+  - [2023-02-07](./travelog/2023-02-07.md)
+  - [2023-02-10](./travelog/2023-02-10.md)

pages/cli.md

@@ -0,0 +1,42 @@
+# CLI
+
+To ease development, a `justfile` is available with the following commands:
+
+- first, install [Just](https://just.systems/man/en/chapter_4.html?highlight=brew#packages)
+- then you can list all available commands:
+
+  ```sh
+  just
+  ```
+
+  This is more or less what you should get:
+
+  ![just recipes](./pictures/just-recipes.png)
+
+- generally speaking, while coding you will most likely be interested in these commands:
+  - run once on install, to create folders if missing
+
+    ```sh
+    just setup
+    ```
+
+  - copy files to game dir *before launching game*:
+
+    ```sh
+    just build
+    ```
+
+  - copy files to game dir *while game is running* (excluding `archive`, see below):
+
+    ```sh
+    just rebuild
+    ```
+
+## ℹ️ Coding process
+
+1. build:
+   - `archive` can only be reloaded from Wolvenkit GUI's Hot Reload (RED Hot Tools required) while game is running.
+   - `tweaks`, `scripts` and `mods` can be just copied over to game files.
+2. refresh:
+   - once done, click in CET console:`archive` for WolvenKit archive, TweakXL `tweaks`, REDscript `scripts` and CET `reload all mods`
+3. remember that depending on what you changed reloading a save is necessary, or the game itself sometimes.