https://github.com/bf4r/slap
Simulation framework
https://github.com/bf4r/slap
c-sharp cli cli-app csharp dotnet oop simulation simulation-framework
Last synced: 10 months ago
JSON representation
Simulation framework
- Host: GitHub
- URL: https://github.com/bf4r/slap
- Owner: bf4r
- License: mit
- Created: 2025-01-30T13:59:39.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-03-20T05:42:27.000Z (10 months ago)
- Last Synced: 2025-03-20T06:29:42.375Z (10 months ago)
- Topics: c-sharp, cli, cli-app, csharp, dotnet, oop, simulation, simulation-framework
- Language: C#
- Homepage:
- Size: 133 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# slap
Simulation framework
## About
Slap stands for "Simulation app" and is a C# object-oriented framework for simulating a real-time ecosystem using classes, methods and properties and how they interact with each other.
The goal is to represent the world around us in a way you can define with custom sets of objects and provide an API for a fictional world where every entity has the properties it needs to simulate a system.
Create your own world by adding objects and relationships between them. You can skip through time using `Sim.WaitMinutes(5)` or similar.
Just add this:
```
using slap;
```
You probably also want `slap.Things`, `slap.Things.Society`, etc.
**The project is a work in progress, so these examples might already be heavily outdated. Check the source code for actual guidance because most objects (or "things") are public and accessible.**
## Requirements
[.NET 9.0 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)
## Installation & Usage
To use Slap in its early development stage, you can clone the repository, navigate to the directory with Program.cs and type:
```
dotnet run
```
This will run the code in Program.cs based on the current testing program. On the master branch, this program is mostly a showcase of what Slap has to offer.
I encourage you to edit Program.cs and look through the other source files, especially in `Things/`, where you will find all the objects in `slap.Things` which are the main components of the simulation. Tests.cs has some examples on how to use them.
## Coming soon
- I have lots of features and new objects planned, so please stay tuned!
- I can't write them here because the todo list is constantly changing.