From 4d39e7636a9daefa9320881f7b7c8eac14179879 Mon Sep 17 00:00:00 2001 From: Tony Bark Date: Mon, 13 May 2024 17:53:05 -0400 Subject: [PATCH] Added some more documentation - Details on structure and d20 system - Updated Github Actions for Ubuntu - Fixed typo in README --- .github/workflows/build.yml | 46 ++++++++++++++++----------- README.md | 9 +++--- docs/structure.md | 8 +++++ library/extra/d20/README.md | 19 +++++++++++ resources/items/dorm/chair/chair.json | 2 +- 5 files changed, 60 insertions(+), 24 deletions(-) create mode 100644 docs/structure.md create mode 100644 library/extra/d20/README.md diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 53e94d1..2449168 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,10 +1,10 @@ name: Build on: - push: - branches: [main, dev] - pull_request: - branches: [main, dev] + push: + branches: [main, dev] + pull_request: + branches: [main, dev] jobs: build: @@ -21,19 +21,29 @@ jobs: run: zig build - name: Test run: zig build test - # ubuntu-build: - # timeout-minutes: 15 - # continue-on-error: true - # runs-on: ubuntu-latest - # steps: - # - uses: actions/checkout@v2 - # - uses: goto-bus-stop/setup-zig@v2 - # - name: Install OpenGL - # run: apt-get libglu1-mesa-dev freeglut3-dev mesa-common-dev - # - name: Build - # run: zig build - # - name: Test - # run: zig build test + ubuntu-build: + timeout-minutes: 15 + continue-on-error: true + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: goto-bus-stop/setup-zig@v2 + - name: setup dependencies + run: | + sudo apt-get update + sudo apt-get install \ + libasound2-dev \ + libx11-dev \ + libxrandr-dev \ + libxi-dev \ + libgl1-mesa-dev \ + libglu1-mesa-dev \ + libxcursor-dev \ + libxinerama-dev + - name: Build + run: zig build + - name: Test + run: zig build test lint: needs: build timeout-minutes: 15 @@ -42,4 +52,4 @@ jobs: steps: - uses: actions/checkout@v2 - uses: goto-bus-stop/setup-zig@v2 - - run: zig fmt --check . \ No newline at end of file + - run: zig fmt --check . diff --git a/README.md b/README.md index 371b82c..c94acc9 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,11 @@

GitHub License GitHub Pull Requests GitHub Issues -

My Simulation is an **experimental** open source multiplayer game based upon The Sims Online. It attempts to mimic the original game as closely as possible while extending it with new features. -The client is written in Zig and uses RayLab game engine with NioTSO's libraries for interacting with The Sims' proprietary formats. FreeSO's API server is used for the backend. +The client is written in Zig and uses Raylib game engine with NioTSO's libraries for interacting with The Sims' proprietary formats. FreeSO's API server is used for the backend. ## Motivation @@ -66,7 +65,7 @@ Further details on building can be found at [compiling.md](./docs/compiling.md). They're many ways you can contribute to My Simulation such as trying things out, filing bugs, and joining in the discussion! - How to Contribute (coming soon) -- [Pull Requests]([https://github.com/tonytins/mysimulatione/pulls](https://github.com/tonytins/mysimulation/pulls)): [Open](https://github.com/tonytins/mysimulation/pulls)/[Closed](https://github.com/tonytins/mysimulation/pulls?q=is%3Apr+is%3Aclosed) +- [Pull Requests](<[https://github.com/tonytins/mysimulatione/pulls](https://github.com/tonytins/mysimulation/pulls)>): [Open](https://github.com/tonytins/mysimulation/pulls)/[Closed](https://github.com/tonytins/mysimulation/pulls?q=is%3Apr+is%3Aclosed) ## License @@ -77,11 +76,11 @@ the Free Software Foundation, either version 3 of the License, or This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License -along with this program. If not, see . +along with this program. If not, see . ## Disclaimer diff --git a/docs/structure.md b/docs/structure.md new file mode 100644 index 0000000..ba851a8 --- /dev/null +++ b/docs/structure.md @@ -0,0 +1,8 @@ +# Project Structure + +Work in progress. + +- **/src** Client written in Zig. +- **/library** C code used by the client. +- **/resources** Assets used by the game. +- **/server** C# code from FreeSO. diff --git a/library/extra/d20/README.md b/library/extra/d20/README.md new file mode 100644 index 0000000..b45d8a3 --- /dev/null +++ b/library/extra/d20/README.md @@ -0,0 +1,19 @@ +# d20 System + +Normally, skills are used for reward interactions, repairs and increased payment. The d20 library is intended to agument this system by adding in a level of chance to certain. + +## Scale + +| Point | Modifier | +| ----- | -------- | +| 0 | -3 | +| 1-2 | -2 | +| 3-4 | -1 | +| 5-6 | +0 | +| 7-8 | +1 | +| 9-10 | +2 | +| 11-12 | +3 | +| 13-14 | +4 | +| 15-16 | +5 | +| 17-18 | +6 | +| 19-20 | +7 | diff --git a/resources/items/dorm/chair/chair.json b/resources/items/dorm/chair/chair.json index ee0fdd4..6118ea9 100644 --- a/resources/items/dorm/chair/chair.json +++ b/resources/items/dorm/chair/chair.json @@ -27,7 +27,7 @@ "bladder": 0 }, "skills": { - "cooking": 5, + "cooking": 0, "mechanical": 0, "charism": 0, "body": 0,