Added some more documentation

- Details on structure and d20 system
- Updated Github Actions for Ubuntu
- Fixed typo in README
This commit is contained in:
Tony Bark 2024-05-13 17:53:05 -04:00
parent 6f6cb68d31
commit 4d39e7636a
5 changed files with 60 additions and 24 deletions

View file

@ -1,10 +1,10 @@
name: Build name: Build
on: on:
push: push:
branches: [main, dev] branches: [main, dev]
pull_request: pull_request:
branches: [main, dev] branches: [main, dev]
jobs: jobs:
build: build:
@ -21,19 +21,29 @@ jobs:
run: zig build run: zig build
- name: Test - name: Test
run: zig build test run: zig build test
# ubuntu-build: ubuntu-build:
# timeout-minutes: 15 timeout-minutes: 15
# continue-on-error: true continue-on-error: true
# runs-on: ubuntu-latest runs-on: ubuntu-latest
# steps: steps:
# - uses: actions/checkout@v2 - uses: actions/checkout@v2
# - uses: goto-bus-stop/setup-zig@v2 - uses: goto-bus-stop/setup-zig@v2
# - name: Install OpenGL - name: setup dependencies
# run: apt-get libglu1-mesa-dev freeglut3-dev mesa-common-dev run: |
# - name: Build sudo apt-get update
# run: zig build sudo apt-get install \
# - name: Test libasound2-dev \
# run: zig build test 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: lint:
needs: build needs: build
timeout-minutes: 15 timeout-minutes: 15
@ -42,4 +52,4 @@ jobs:
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- uses: goto-bus-stop/setup-zig@v2 - uses: goto-bus-stop/setup-zig@v2
- run: zig fmt --check . - run: zig fmt --check .

View file

@ -6,12 +6,11 @@
<p align="center"> <p align="center">
<img alt="GitHub License" src="https://img.shields.io/github/license/tonytins/mysimulation"> <img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr/tonytins/mysimulation"> <img alt="GitHub Issues" src="https://img.shields.io/github/issues/tonytins/mysimulation"> <img alt="GitHub License" src="https://img.shields.io/github/license/tonytins/mysimulation"> <img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr/tonytins/mysimulation"> <img alt="GitHub Issues" src="https://img.shields.io/github/issues/tonytins/mysimulation">
</p> </p>
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. 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 ## 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! 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) - 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 ## 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, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of 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. GNU General Public License for more details.
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
## Disclaimer ## Disclaimer

8
docs/structure.md Normal file
View file

@ -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.

View file

@ -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 |

View file

@ -27,7 +27,7 @@
"bladder": 0 "bladder": 0
}, },
"skills": { "skills": {
"cooking": 5, "cooking": 0,
"mechanical": 0, "mechanical": 0,
"charism": 0, "charism": 0,
"body": 0, "body": 0,