Fix paths

rxqd · Jun 13, 2024 · 1561d16 · 1561d16
1 parent a9ea9f7
commit 1561d16
Show file tree

Hide file tree

Showing 13 changed files with 53 additions and 47 deletions.
diff --git a/sim_log/CHANGELOG → CHANGELOG b/sim_log/CHANGELOG → CHANGELOG
diff --git a/README.md b/README.md
@@ -1 +1,52 @@
-# od_tools
+# Log generator for [OpenDominion Game](https://github.com/OpenDominion/OpenDominion)
+
+Converted from the script included in sim file from [Yami-10/OD-Simulator](https://github.com/Yami-10/OD-Simulator)
+
+# The idea
+
+I work on Linux so don't have Excel and has no ability to generate `log.txt` from sim file.
+
+This tool writen in [GO](https://go.dev/) can generate `log.txt` from Excel file
+both local and downloaded from Google Sheet. It should work in any Operation System.
+
+The code contains only final script generation logic. All other things left the same in Excel file.
+
+Remember to open Excel sim before generation. ALl formulas should run and update their values with Excel.
+
+# Get binary
+
+You can use prebuilt binaries at [Releases](https://github.com/rxx/od_tools/releases) or build from sources with
+
+To install `go` check [instructions here](https://go.dev/doc/install)
+
+and then run
+
+```
+go install github.com/rxx/od_tools/sim@latest
+```
+
+it installs to `GOPATH/bin` with a name `sim`.
+
+Rename it whatever you like.
+
+Make sure `GOPATH` is visible to the system. [This guide](https://go.dev/wiki/SettingGOPATH) will help you.
+
+# Usage
+
+Next will work for Linux and Mac
+
+```
+sim generate_log -sim OpenDominionSim.xlsm -result sim.txt
+```
+
+For windows you can also run `sim` from terminal or put command line to the exe options.
+
+I don't have Windows and can't test and describe the actual process, it would be helpfull if someone describe that and make a pull request ^\_^
+
+Get file from [Yami-10/OD-Simulator](https://github.com/Yami-10/OD-Simulator)
+
+# Bug reports
+
+If you see any issues or want an improvement, feel free to create an issue and describe the problem.
+
+Write me in Discord @max_masterius
diff --git a/sim_log/TODO.md → TODO.md b/sim_log/TODO.md → TODO.md
diff --git a/sim_log/go.mod → go.mod b/sim_log/go.mod → go.mod
@@ -1,4 +1,4 @@
-module github.com/rxx/od_sim
+module github.com/rxx/od_tools
 
 go 1.21.8
 

diff --git a/sim_log/go.sum → go.sum b/sim_log/go.sum → go.sum
diff --git a/sim_log/justfile → justfile b/sim_log/justfile → justfile
diff --git a/sim_log/commands.go → sim/commands.go b/sim_log/commands.go → sim/commands.go
diff --git a/sim_log/generate_log.go → sim/generate_log.go b/sim_log/generate_log.go → sim/generate_log.go
diff --git a/sim_log/generate_log_test.go → sim/generate_log_test.go b/sim_log/generate_log_test.go → sim/generate_log_test.go
diff --git a/sim_log/helpers.go → sim/helpers.go b/sim_log/helpers.go → sim/helpers.go
diff --git a/sim_log/main.go → sim/main.go b/sim_log/main.go → sim/main.go
diff --git a/sim_log/parse_log.go → sim/parse_log.go b/sim_log/parse_log.go → sim/parse_log.go
diff --git a/sim_log/README.md b/sim_log/README.md