Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DataBeaver committed May 17, 2021
1 parent 866c91b commit 284fb2f
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
trimps-tools - Offline utilities for Trimps
Copyright © 2018-2019 Mikkosoft Productions
Copyright © 2018-2021 Mikkosoft Productions

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Tools to assist in decision-making for the browser game
[Trimps](https://trimps.github.io/).

Copyright © 2018-2019 Mikkosoft Productions
Copyright © 2018-2021 Mikkosoft Productions
Licensed under GPLv3.


Expand All @@ -10,6 +10,9 @@ Licensed under GPLv3.
To compile the programs, simply type make. No additional libraries are
required.

If using MinGW to compile for Windows, make sure to use the posix variant.
The win32 variant of MinGW does not support C++ threads.


## Spire optimizer

Expand All @@ -18,7 +21,17 @@ utilizes a genetic algorithm to search for the layout with best damage or
income. In the simplest form, pass your current layout as a command line
argument and the program will try to find a layout that does more damage while
not requiring more runestones. The behaviour can be further customized with
options. Some of the more important are:
options described below.

### 128-bit version

The programs can use 128-bit math to work with numbers larger than about 9Qi.
A 128-bit build is provided in the releases as spire128.exe. To compile it
yourself, set `-DWITH_128BIT` in `CXXFLAGS`;

### Command-line options

Some of the more important options are:

-f, --floors
Set the number of floors in the spire
Expand Down Expand Up @@ -76,6 +89,12 @@ options. Some of the more important are:
Perform database query in live mode and automatically obtain improvements
that other users submit into the database. Implies --online.

--athome
Run in spire@home mode, working on random layouts from the online layout
database. Most other options are ignored, but you may want to use -w to
control how much processing power the program consumes. Only available in
128-bit builds.

More advanced options can be used to tweak the performance of the program or
the genetic algorithm:

Expand Down

0 comments on commit 284fb2f

Please sign in to comment.