mirror of
https://github.com/Facepunch/sbox-public.git
synced 2025-12-23 22:48:07 -05:00
71f266059a
This commit imports the C# engine code and game files, excluding C++ source code. [Source-Commit: ceb3d758046e50faa6258bc3b658a30c97743268]
67 lines
2.5 KiB
Markdown
67 lines
2.5 KiB
Markdown
<div align="center">
|
|
<img src="https://sbox.game/img/sbox-logo-square.svg" width="80px" alt="s&box logo">
|
|
|
|
[Website] | [Getting Started] | [Forums] | [Documentation] | [Contributing]
|
|
</div>
|
|
|
|
[Website]: https://sbox.game/
|
|
[Getting Started]: https://sbox.game/dev/doc/about/getting-started/first-steps/
|
|
[Forums]: https://sbox.game/f/
|
|
[Documentation]: https://sbox.game/dev/doc/
|
|
[Contributing]: CONTRIBUTING.md
|
|
|
|
# s&box
|
|
|
|
s&box is a modern game engine, built on Valve's Source 2 and the latest .NET technology, it provides a modern intuitive editor for creating games.
|
|
|
|
|
|
|
|
If your goal is to create games using s&box, please start with the [getting started guide](https://sbox.game/dev/doc/about/getting-started/first-steps/).
|
|
This repository is for building the engine from source for those who want to contribute to the development of the engine.
|
|
|
|
## Getting the Engine
|
|
|
|
### Steam
|
|
|
|
You can download and install the s&box editor directly from [Steam](https://sbox.game/give-me-that).
|
|
|
|
### Compiling from Source
|
|
|
|
If you want to build from source, this repository includes all the necessary files to compile the engine yourself.
|
|
|
|
#### Prerequisites
|
|
|
|
* [Git](https://git-scm.com/install/windows)
|
|
* [Visual Studio 2026](https://visualstudio.microsoft.com/)
|
|
* [.NET 10 SDK](https://dotnet.microsoft.com/en-us/download)
|
|
|
|
#### Building
|
|
|
|
```bash
|
|
# Clone the repo
|
|
git clone https://github.com/Facepunch/sbox-public.git
|
|
```
|
|
|
|
Once you've cloned the repo simply run `Bootstrap.bat` which will download dependencies and build the engine.
|
|
|
|
The game and editor can be run from the binaries in the game folder.
|
|
|
|
## Contributing
|
|
|
|
If you would like to contribute to the engine, please see the [contributing guide](CONTRIBUTING.md).
|
|
|
|
If you want to report bugs or request new features, see [sbox-issues](https://github.com/Facepunch/sbox-issues/).
|
|
|
|
## Documentation
|
|
|
|
Full documentation, tutorials, and API references are available at [sbox.game/dev/](https://sbox.game/dev/).
|
|
|
|
## License
|
|
|
|
The s&box engine source code is licensed under the [MIT License](LICENSE.md).
|
|
|
|
Certain native binaries in `game/bin` are not covered by the MIT license. These binaries are distributed under the s&box EULA. You must agree to the terms of the EULA to use them.
|
|
|
|
This project includes third-party components that are separately licensed.
|
|
Those components are not covered by the MIT license above and remain subject
|
|
to their original licenses as indicated in `game/thirdpartylegalnotices`. |