Skip to content

Latest commit

 

History

History
127 lines (103 loc) · 6.01 KB

README.md

File metadata and controls

127 lines (103 loc) · 6.01 KB

Milsim-Prop-Alpha1

License Maintenance GitHub last commit GitHub package.json version Lines of code GitHub contributors

This project is an open-source game prop for military simulation games such as airsoft, paintball and others. It is designed to run on the ESP-family of IoT devices created by Espressif Systems. It specifically targets the ESP32 and ESP32S modules which can be bought from a wide range of sources.

These controllers have build in WiFi which enables the prop to be configured and controlled from a smart phone using a web browser.

Patreon

If you want to support me in developing this project please join my Patreon at https://www.patreon.com/nbenik. Every little bit helps with the parts, board development, shipping and energy drinks required to keep pounding through this big project.

Table of Contents

Licenses

Designed by Nick Benik for STEALTH_CORP. STEALTH_CORP owns all protected IP. Everything that is not otherwise stated as being protected IP is released under permissive copyleft licenses.

Sector License Verison
Hardware CERN-OHL-S 2.0
Firmware GNU GPL 3.0
Documentation CC BY-SA 4.0
Game Stories CC BY-SA 4.0
Audio Content See LICENSE files in MP3 directories

Files of all licenses are required with the distribution of files. All files are available in easy-to-modify formats for remixing.

Artwork

The design and layout, the main artwork on the board and the PCB layers and traces, are NOT protected Intellectual Property ("IP"), see LICENSE files for appropriate details. Any additional writing or images such as the Brooklyn Tactical name, logo or copyright and designer notices, and certifications ARE considered protected IP and notice is given that they are protected by all applicable IP laws.

Audio Files

All associated audio files are licensed for use in the building and operation of the Milsim-Prop-Alpha1 product only! Additional reuse of the audio clips in other products or the redistribution of audio clips is prohibited and in violation of our licensing and sub-licensing agreements. Please behave and don't get us sued. If you contribute your own audio files for this project you may agree to have your audio files used under a more permissive license if you document your file(s) and chosen license in the associated LICENSE.md file in the audio file's directory.

TLDR; Audio files are not Open Source compatable.

Task List

  • Hardware design

  • PCB prototype

  • Commercial Product: 3D prints design

  • Commercial Product: prototype

  • Commercial Product: field testing

  • Compile/Build system

  • Internationalization design/build

  • Firmware: main loop

  • Firmware: wifi configurator

  • Firmware: game mode selector

  • Firmware: web server - game template

  • Firmware: Buttons Service

  • Firmware: LCD Service

  • Firmware: MP3 Service

  • Design networking protocols

  • Firmware: Networking Service

  • Firmware: RFID Service

  • Firmware: Accelerometer Service

  • Game Mode: Team Picker & Traitor Picker

  • Game Mode: Domination - Story

  • Game Mode: Domination - Design

  • Game Mode: Domination - Coding

  • Game Mode: Sabotage - Story

  • Game Mode: Sabotage - Design

  • Game Mode: Sabotage - Coding

  • Game Mode: Heist - Story

  • Game Mode: Heist - Design

  • Game Mode: Heist - Coding

  • Game Mode: Contagion - Story

  • Game Mode: Contagion - Design

  • Game Mode: Contagion - Coding

  • Game Mode: Broken Arrow - Story

  • Game Mode: Broken Arrow - Design

  • Game Mode: Broken Arrow - Coding

  • Game Mode: Broken Quiver - Story

  • Game Mode: Broken Quiver - Design

  • Game Mode: Broken Quiver - Coding

  • Game Mode: Bio Weapon - Story

  • Game Mode: Bio Weapon - Design

  • Game Mode: Bio Weapon - Coding

  • Add-on prop: Bio Weapon - Bio Container

  • Add-on prop: Bio Weapon - Bio Freezer

  • Add-on module: Keypad

  • Add-on module: Cut wire module

  • Add-on module: Prop wired communicator

  • Add-on module: GPS module