Няма описание

Zelphir Kaltstahl 704770b13a set sign of karma modifier for events преди 4 години
config 704770b13a set sign of karma modifier for events преди 4 години
guix-env 9397b5444d add guix environment files преди 4 години
lib ef8929989b fix wrong call to range преди 4 години
python-env bffb9ef2c6 add python environment files преди 4 години
.gitignore bb58e405ed update gitignore file преди 4 години
.gitmodules 9e1812c61b add fslib as submodule to deal with locations in file systems преди 4 години
LICENSE f42cf3cb83 Initial commit преди 4 години
config.scm efaccd5a26 reorganize code and separate out data abstraction layer преди 4 години
data-abstraction.scm 6925d9f0b2 adapt data abstraction layer преди 4 години
effect.scm 2cf7a774f7 implement custom actions преди 4 години
main.scm 2cf7a774f7 implement custom actions преди 4 години
model.scm 67285d662d adapt remaining code to use event outcome преди 4 години
notes.org 42f48be39d add todo item преди 4 години
readme.md 18681fe3fd update readme, fix copy paste mistake преди 4 години
readme.org 18681fe3fd update readme, fix copy paste mistake преди 4 години
start.bash 3bf6710765 adapt start script to new library location преди 4 години
validate.bash f15787204c add validation script преди 4 години

readme.md

Fantasy Vacation Planner

This project contains a program for simulating an imaginary vacation trip.

Dependencies

The program depends on the following software:

  • GNU Guile 3.0.4 – Earlier versions not tested, but the program is not using anything special, so probably an earlier version will work just fine, as long as the other required libraries exist for that earlier version.
  • guile-json of GNU Guix commit (revision) 8518a3692cbb9cd96d69c03e9de9ad6fdcfebbee – Other versions were not tested. However, the program does not use advanced features of the library, so other versions will probably work fine as well.

Potential dependencies

  • The provided GNU Guix environment specification depends on GNU Guix being installed.

Usage

Clone the repository using:

git clone --recurse-submodules --remote-submodules URL

Or, if you are using an older version of git:

git clone URL
cd DIR_OF_REPO
git submodule update --init --recursive

A GNU Guix environment setup script is provided in guix-env/env.bash. You can run it using GNU Bash from the root directory of the cloned repository:

bash guix-env/env.bash

After which you will have the required libraries to run the program. You can run the program from the root directory of this project as follows:

GUILE_LOAD_PATH="${GUILE_LOAD_PATH}:lib/fslib" \
    guile -L . main.scm

Alternatively, you can mke use of the provided GNU Bash script in the root directory of the cloned repostitory:

bash start.bash

If you do not have GNU Guix installed, you need to consult the list of dependencies and make sure you got them satisfied, before running the program.

Configuring the journey

Events that can occur while travelling as well as the difficulty of the journey are specified in story-parameters.json.

Configuring participating players

The players and their routes are specified in story.json.

Validating the configuration files

There are JSON schemas given for configuration files as ...-schema.json. To make use of them, you may use any program you want to use for validating the configuration files against their corresponding JSON schema. A little Python 3 program is given in validate.py, which validates using the jsonschema library from PyPI. To use it do the following:

  1. Run bash python-env/env.bash from the root directory of this project, to create a Python venv.
  2. Run source python-env/venv/bin/activate to activate the venv.
  3. Run the validation program using python3 validate.py.