townforge/README-binaries.md
2020-07-04 10:22:31 +00:00

57 lines
1.9 KiB
Markdown

# Townforge
Townforge is a blockchain based game based on the Monero source. Buy land, create buildings and research new technologies.
Copyright (c) 2019-2020 Crypto City
Copyright (c) 2014-2020 The Monero Project.
Portions Copyright (c) 2012-2013 The Cryptonote developers.
- Web: [www.townforge.net](https://www.townforge.net)
- Git: [https://git.townforge.net/townforge/townforge](https://git.townforge.net/townforge/townforge)
- Forum: [forum.townforge.net](https://forum.townforge.net)
- IRC: [##townforge on Freenode](https://webchat.freenode.net/?randomnick=1&channels=%23%23townforge&prompt=1&uio=d4)
## License
See [LICENSE](LICENSE).
## Running Townforge
In order to run, both the node and the game need to run.
THe node (townforged) handles the blockchain and connection to the Townforge
network, while the game uses the node.
To run the node:
```bash
./townforged
```
To list all available options, run `./townforged --help`. Options can be
specified either on the command line or in a configuration file passed by the
`--config-file` argument. To specify an option in the configuration file, add
a line with the syntax `argumentname=value`, where `argumentname` is the name
of the argument without the leading dashes, for example `log-level=1`.
To run in background:
```bash
./townforged --log-file townforged.log --detach
```
To run as a systemd service, copy
[townforged.service](utils/systemd/townforged.service) to `/etc/systemd/system/` and
[townforged.conf](utils/conf/townforged.conf) to `/etc/`. The [example
service](utils/systemd/townforged.service) assumes that the user `townforge` exists
and its home is the data directory specified in the [example
config](utils/conf/townforged.conf).
If you're on Mac, you may need to add the `--max-concurrency 1` option to
townforge-wallet-cli, and possibly townforged, if you get crashes refreshing.
# running the game
```bash
./townforge
```