mysimulation/README.md
Tony Bark 00255a6c17 Map view
- Not a perfect map view, butit does work
- Removed changeRotations() in favor of init()
- Removed FreeBSD and Tiers from system requirements in README
- Fixed typo in README
2024-05-07 03:11:16 -04:00

3 KiB

My Simulation

GitHub License GitHub Issues or Pull Requests GitHub Actions Workflow Status

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.

Motivation

See motivation.md for motivation and vision.

Requirements

Prerequisites

  • The Sims Online
  • Client
  • API Server
  • Libraries & Tools
    • TBA

System Requirements

Platform Version Architectures
Windows 10+ x86_64, aarch64
Linux 3.16+ x86_64
macOS 11.0+ x86_64, aarch64

Getting Started

  1. Clone the Repository:

    git clone https://github.com/tonytins/mysimulation.git
    
  2. Navigate to the Repository:

    cd mysimulation
    
  3. Run the Client:

    zig build run
    

Further details on building can be found at compiling.md.

Contributing

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: Open/Closed

License

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 the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

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 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 http://www.gnu.org/licenses/.

Disclaimer

My Simulation is not in any way affiliated with Electronic Arts, Maxis or The Sims, it is an unofficial community run project.