README.md

# Notice

This is the new home of Fort of Chains codebase,
previously located at
https://gitgud.io/darkofocdarko/foc
.
A critical git corruption forced us to remake the repository from scratch.

## Fort of Chains

[(v1.8.1.0 release notes)](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/update/readme_1_8.md)
|
[(Download instructions)](https://gitgud.io/darkofocdarko/fort-of-chains#how-to-play-the-latest-version-of-the-game)
|
[(Play in Browser (slightly outdated))](https://darkofoc.itch.io/fort-of-chains)
|
[(Contributing)](https://gitgud.io/darkofocdarko/fort-of-chains#how-to-contribute-content)
|
[(F.A.Q)](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/faq.md)
|
[(Feature / Fetish list)](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/faq.md#does-this-game-contain-insert-fetish-here)
|
[(Discord)](https://discord.com/invite/PTD9D7mZyg)

**Fort of Chains** is a completed, free, moddable,
[open-source](https://gitgud.io/darkofocdarko/fort-of-chains),
TEXT-ONLY
sandbox management NSFW game where you lead and manage a band of slavers in a fantasy world.
The game is configurable and can cover all gender orientations: MM, MF, and FF.
Be warned that the game contains heavy themes of slavery and non-consensual sex.
There are [no support](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/faq.md#can-you-play-a-submissive-in-this-game)
for playing as a submissive character.
[(Feature / Fetish list)](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/faq.md#does-this-game-contain-insert-fetish-here)

**Key designs.**
This game is designed to be a **short-story-teller** machine:
the core gameplay loop involves assigning groups of slavers to quests,
reading what happens to them, and finally reaping the quests' rewards.
This game is **complete**:
all features, bugfixes, polish, balancing, and originally planned stories are finished.
But improvements and community-made contributions are still being added continuously to the game.

**Contributing.**
The game is always looking for all and any kind of contributions.
More details [here](https://gitgud.io/darkofocdarko/fort-of-chains#how-to-contribute-content).
As of v1.7, more than 40 kind contributors have helped by directly adding content into the game,
while much more have helped playtest the game and give feedbacks.
Drop by the [(Discord)](https://discord.com/invite/PTD9D7mZyg) if you are interested!
(If you use Discord, you can tell us your discord name too so we can give you a Discord role,
which among other things allows you to bypass the seven days wait required there.)

There are several ways to contribute to this game:

**Contributing story.**
You can help support this game by adding your stories into the game,
which can be in the form of quests, events, or any other form you'd like.
**No programming knowledge required.**
This is possible thanks to the built-in GUI tool in the game for adding content:
the Content Creator Tool.
As long as you have a story in mind, simply follow the instructions in-game
to add your story into the game.

To get started, open the game, and click the `Content Creator Tool` link from the starting screen.
If you need help in the game, make sure to click the `(?)` help menu found everywhere in the game.

When you are done, you can submit the finished story either
in the `#your-contribution` channel in
[Discord](https://discord.com/invite/PTD9D7mZyg),
or directly in the [repository](https://gitgud.io/darkofocdarko/fort-of-chains).
If the story fits the game, it will be added pronto, with a lot of thanks!
[(More information)](https://gitgud.io/darkofocdarko/fort-of-chains#submitting-your-content).

**Contributing art.**
The game welcomes artistic contributions!
Please check [this document](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/images.md) for more details.

**Contributing code and others.**
This game is [open-source](https://gitgud.io/darkofocdarko/fort-of-chains).
Coding help, play-testing, and all other kinds of contributions are also welcomed.
We are also looking for people willing to help writers put their content into a merge request.
See [here](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/todolist.md#other) for other contribution
ideas.

**Questions?**
If you are hoping to contribute something and have questions, please do not hesitate to ask in
[Discord](https://discord.com/invite/PTD9D7mZyg).
(If you are a contributor and also on Discord, let us known your
discord ID here so we can give you a Discord role, which among other things allows you to bypass the
seven days wait there.)
Don't know what to contribute?
See [here](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/todolist.md) for ideas.

**Vision**
Fort of Chains is a passion project. My hope is that one day, the project will be entirely community-led,
and I can take a back seat as just a regular contributor :)

## Important Links and Informations

### Key resources
[Discord](https://discord.com/invite/PTD9D7mZyg) |
[Changelog (Summary)](docs/changelog_summary.md) |
[Changelog (Detailed)](changelog.txt)

### Contributing
[Content Guidelines](docs/contentguideline.md) |
[What Kind of Content to Add](docs/content.md) |
[Content Creator Cheat Sheet](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/textcheatsheet.md) |
[Adding Sex Actions](docs/sexaction.md) |
[Special Commands in Content Creator](docs/text.md) |
[Merge Request Tutorial](docs/mergerequest.md) |
[Test / Deployment Guide](docs/deploy.md)

### Wiki
[Lore](docs/lore.md) |
[Traits](docs/traits.md) |
[Features](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/faq.md#is-insert-feature-here-planned-for-the-game) |
[Fetishes](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/faq.md#does-this-game-contain-insert-fetish-here)

### Miscellaneous
[F.A.Q](docs/faq.md) |
[Creating Image Pack](docs/images.md) |
[Adding Room Image](docs/roomimages.md) |
[Repository Structure](docs/structure.md) |
[Stats](docs/stats.md)

## How to Play the Latest Version of the Game

1. Download this repository [here](https://gitgud.io/darkofocdarko/fort-of-chains/-/archive/master/fort-of-chains-master.zip)
2. Open the `dist/precompiled.html` file in your favorite browser.
3. Alternatively, you can download a somewhat outdated version of
this game in [itch.io](https://darkofoc.itch.io/fort-of-chains#download).

If you encounter problems such as images not loading, pleasee see the [F.A.Q](docs/faq.md).

## How to Contribute Content

**Writers**
can contribute stories in the form of quests, events, etc.
It is very easy, and **no programming skill is required**!
Follow the in-game steps in the GUI-based `Content Creator Tool` (accessible
from the starting screen of the game).
See [submitting your content](#submitting-your-content) for more information
about what to do after you finish your content.

If you would like to contribute in another way, or if you need help
with implementing your quest,
please come over to
[Discord](https://discord.com/invite/PTD9D7mZyg), or open a new issue
in this repository.
(If you are a contributor and also on Discord, let us known your
discord ID here so we can give you a Discord role, which among other things allows you to bypass the
seven days wait there.)

**Programmers** are also welcome to contribute to the game -- merge requests
are always appreciated!
See [repository structure and code guidelines](docs/structure.md) to ease your entry into the project.

**Artists**, to add images into the game
(e.g., more portraits for units, images for quest / event outcomes, icons, panoramas, room images, and more), see
[this document](docs/images.md).
An option is to give the project permission to use some of your existing
artworks, which is greatly appreciated. The game will try its best to credit you properly.

**Don't know what to contribute?** See [here](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/todolist.md#other) for ideas.

## Compiling Instructions

The main benefit of compiling your game is that you can permanently add into the game and test
the content you have made with the Content Creator Tool.
Compiling is very easy to do, the instructions are as follows.

1. First, download this repository (top right button of this page), then open that directory

2. Step two depends on your operating system:
  - Windows
    1. Run `compile.bat`
    2. Open `dist/index.html` (Don't mistakenly open the adjacent `dist/precompiled.html`!)
  - Linux
    1. Ensure executable permissions on the following files by running:
      i. `sudo chmod +x compile.sh`
      ii. `sudo chmod +x dev/tweeGo/tweego_nix64`
      iii. `sudo chmod +x dev/tweeGo/tweego_nix86`
    2. Run `./compile.sh`
    3. Open `dist/index.html`
  - Mac
    1. Ensure executable permissions on the following files:
      i. `compile.sh`
      ii. `dev/tweeGo/tweego_osx64`
      iii. `dev/tweeGo/tweego_osx86`
    2. Run `./compile.sh`
    3. Open `dist/index.html`

That's it! The code is compiled. Note that you need to compile again
and reload the `index.html` file each time you make changes to the files.
See [here](https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/docs/faq.md#common-compiling-problems)
for common problems you might encounter.

**If you are a programmer:** This compilation method only compiles the [twine files](https://gitgud.io/darkofocdarko/fort-of-chains/-/tree/master/project/twee),
and not the [javascript or css files](https://gitgud.io/darkofocdarko/fort-of-chains/-/tree/master/src).
To compile the javascript or css files, see instructions [here](docs/javascript.md).
To test the game / deploy the game, see instructions [here](docs/deploy.md).

## Submitting your Content

Once your quest is up and running, the final step is to add the quest
you've written into the game permanently, to be played by everyone.
This can be done in two ways:

#### The Discord Way

The first option is to drop the content in
the `#your-contribution` channel in
[Discord](https://discord.com/invite/PTD9D7mZyg).
Someone will then check that it fits the game, and
may give feedbacks.
Once the feedback loop is complete (if any), the content will be put it in the game.
(If you use Discord, you can tell us your discord name too so we can give you a Discord role,
which among other things allows you to bypass the seven days wait required there.)

#### Merge Request Way

The second option is to submit a merge request to this repository.
It is also very simple, and can be done without any programming knowledge.
See [submitting merge requests](docs/mergerequest.md) for a tutorial (with pictures!).

## Credits

This game is created using the Twine engine and a [modified SugarCube 2](https://gitgud.io/darkofocdarko/sugarcube-2).
Project template and various sugarcube macros from [ChapelR](https://github.com/ChapelR/tweego-setup).
Artworks from various sources, mostly under CC-BY-NC-ND 3.0.
(See the in-game credits for the full credits and the list of licenses.)
This game would not be possible without all these people:
BedlamGames for creating
[No Haven](https://www.patreon.com/bedlamgames),
FCdev for creating
[Free Cities](https://www.reddit.com/r/freecitiesgame/), and
Innoxia, for creating
[Lilith's Throne](https://subscribestar.adult/innoxia).
Many thanks also to the contributors of this repository: writers and programmers alike,
which are mentioned in [the in-game credits](project/twee/credits.twee).
Finally, thanks to the many playtesters for their feedbacks and bug reports on the game,
and to you for playing the game.

## License

In short, the license works as follows:

- The original copyright of artworks remain with their artists. The artworks are used in this game
in accordance to the licenses the artworks are released under, e.g., under CC-BY-NC-ND 3.0.

- The original copyright of attributed stories remain with their authors, but the authors allow their
stories to be modified in any way as long as it remains attributed and used only for non-commercial
purposes, like this project.

- Everything else is open-source under GNU GPLv3, which basically means that you can rest assured
that all your contribution and its derivatives will always remain open-source.

Full license under the break.

---

By contributing to this project, contributors agree to irrevocably allow the distribution of
their contributions under these licenses:

- Artworks are used in accordance to the license they are released under,
which can be found in game ("Artists Credits" from the main menu, and from
clicking the portraits), and also in the `imagemeta.js` file in their corresponding
folders. The copyrights of these artworks remain with their original holders.
Icon credits are found here:
https://gitgud.io/darkofocdarko/fort-of-chains/-/blob/master/project/twee/image_credits.twee
.

- Authors contributing writings into this game agree to allow the
distribution of their contributions under CC-BY-NC-SA 4.0 (where the full credits go to the author).
The authors also perpetually allows their stories and all entities inside them to be
reused, modified, or extended in any way within the scope of this project.
The full author credits can be found in-game.
("Writer Credits" from the main-menu, as well as inside the content themselves.)
Uncredited texts are licensed under GNU GPLv3.

- Everything else (including documentations and source code) are licensed under
GNU GPLv3. Exception are some third party libraries --- their licenses are located
in their respective folders.

To view a copy of the CC-BY-NC-SA 4.0 license, visit
https://creativecommons.org/licenses/by-nc-sa/4.0/
.

To view a copy of the GNU GPLv3 license, visit
https://www.gnu.org/licenses/gpl-3.0.en.html
.