Circuit Sandbox is a digital circuit sandbox game where users can create arbitrarily complex circuits out of simple components. Circuit Sandbox is designed from the ground up to support large and complex simulations efficiently.

Circuit Sandbox is currently in development.

Download binaries

Pre-built binaries are available for download for Windows 10. They should run straight out of the box, no installation required.

If you are on Windows 8.1, you might need to install the Windows 10 Universal C Runtime before running Circuit Sandbox.

For other operating systems, you'll have to build it from source.

How to play

Read the user manual for an introduction to Circuit Sandbox.

There are also sample circuits in the samples folder of this repository.

Build from source

A reasonably conforming C++17 compiler is required to compile Circuit Sandbox.

Circuit Sandbox has been tested to compile with Visual Studio 2017 (MSVC 15.7) on Windows and GCC 7.3 on Linux. It might also work with MinGW-w64 on Windows, but a few tweaks might be needed to get it use newer versions of Windows.h.

It probably also compiles on Mac OSX with Clang, but this is untested.

Note: The C runtime has to be linked dynamically due to how Native File Dialog works.

Dependencies

• Boost libraries
  • Headers: Tribool, Process, Endian, Interprocess
  • Link Libraries: System, Filesystem
• SDL2
• SDL2_ttf
• Native File Dialog Extended (NFD)

Building on Windows (Visual Studio 2017)

The Windows releases are built with Boost 1.67.0, SDL2 2.0.8, SDL2_ttf 2.0.14, and the latest NFD from its master branch. Boost and NFD are statically linked to Circuit Sandbox; SDL2 and SDL2_ttf are dynamically linked as recommended by SDL2. The C and C++ runtimes are dynamically linked. To minimise unexpected issues, it is best to build it in the same way.

1. Set-up all the dependencies:

   1. Download Boost and follow these instructions to compile Boost on your computer. Make sure you compile it using the correct toolset (toolset=msvc-14.1). You might also want to build static libraries (link=static).
   2. Download SDL2 and SDL2_ttf, making sure you get the development libraries (not the runtime binaries), and that they are for Visual Studio (not MinGW). Those downloads contain binaries (.dll and .lib), so there is nothing to build. Just unzip the files and place them somewhere on your computer.
   3. Download or clone NFD onto your computer, and use the Visual Studio solution and project files provided by NFD to build it. You don't need to configure anything - they should build correctly out of the box.

2. Open the solution file for Circuit Sandbox in Visual Studio, and define the following property macros that point to the include directories and linker search directories from step 1 (their values will depend on where you have placed the dependencies):

   • Boost_Include
   • SDL_Include
   • SDLTTF_Include
   • NFD_Include
   • Boost_Lib_Debug_x86
   • Boost_Lib_Release_x86
   • SDL_Lib_Release_x86
   • SDLTTF_Lib_Release_x86
   • NFD_Lib_Debug_x86
   • NFD_Lib_Release_x86
   • Boost_Lib_Debug_x64
   • Boost_Lib_Release_x64
   • SDL_Lib_Release_x64
   • SDLTTF_Lib_Release_x64
   • NFD_Lib_Debug_x64
   • NFD_Lib_Release_x64

3. Build Circuit Sandbox; it should work!

Licensing

Circuit Sandbox is licensed under the GNU General Public License version 3. For the complete license text, see the file 'COPYING'.

This license applies to all files in this repository, except the following:

• CircuitSandbox/resources/ButtonIcons.ttf and everything in the CircuitSandbox/resources/icons directory, which are from Google Material Icons and licensed under the Apache License version 2.0.
• CircuitSandbox/resources/OpenSans-Bold.ttf, which is from the Open Sans typeface and licensed under the Apache License version 2.0.
• CircuitSandbox/unicode.hpp, which is from Unicode Utilities and licensed under the MIT License.

In addition to the items stated above, Circuit Sandbox releases also contain binary code from SDL 2.0, SDL_ttf 2.0, Boost C++ Libraries, Native File Dialog Extended, and compiler runtimes for MSVC (Windows), Clang (Mac OS X), and GCC (Linux). SDL_ttf 2.0 further depends on FreeType and Zlib, which are also packaged with the releases. They have their own licenses, which may be different from the license of Circuit Sandbox.

Credits

• Bernard Teo Zhi Yi
• Kuan Wei Heng

This project was built for CP2106 Independent Software Development Project (Orbital) at the National University of Singapore (NUS). NUS owns the copyright for all source code and assets up to and including the v0.4 release.