Recoil: Difference between revisions

Latest revision as of 21:38, 23 February 2026

Recoil is a battle tested open-source RTS engine that, allied with a flexible Lua API, allows you to implement the perfect UI and mechanics for your game with the ability to support thousands of complex units simultaneously.

Recoil is a recent hard fork of [Spring](https://github.com/spring/spring) from the [105 tree](https://github.com/spring/spring/releases/tag/105.0.1), many references to it might and will be present. Overall most documented Spring API and tutorials are compatible with Recoil since they are based on the 105 tree.

Getting started

This site is an early work-in-progress so content will mostly be references to Spring documentation until its own guides are written.

Want to know if recoil is right for your project? Find out here!

@@ Line 1: / Line 1: @@
-{{stub}}
+<div style="text-align: center;">
+<h2 data-notoc="">Recoil is a battle tested open-source RTS engine that, allied with a flexible Lua API, allows you to implement the perfect UI and mechanics for your game with the ability to support thousands of complex units simultaneously.</h2>
+</div>
-Welcome to the Recoil RTS engine wiki!
+{{Note|text=Recoil is a recent hard fork of [Spring](https://github.com/spring/spring) from the [105 tree](https://github.com/spring/spring/releases/tag/105.0.1), many references to it might and will be present. Overall most documented Spring API and tutorials are compatible with Recoil since they are based on the 105 tree.}}
-Recoil RTS engine is a continuation and significant extension of the original Spring RTS engine version 105.0: https://github.com/spring/spring/tree/105.0
+# Getting started
-Recoil RTS changes and additions are listed here: https://beyond-all-reason.github.io/spring/changelogs
+{{Note|This site is an early work-in-progress so content will mostly be references to Spring documentation until its own guides are written.}}
+Want to know if recoil is right for your project? Find out here!
----
-Recoil's focus as an engine is unit management and rendering. Pretty much everything else is up to you. This can be... intimidating, like being asked to build a car that has just an engine. So, over the years, the community has accrewed a suite of Lua scripts that cover much of the low-level stuff. This is where the idea of gadgets and widgets comes from; they are not actually part of the engine, but instead an abstraction over the bare bones of Recoil that the community developed.
-Eventually, it was rolled into the engine, and the VFS will fall back on these scripts if you do not override them. You can, of course, copy the scripts and modify them to suit your needs, as most games eventually do. You can find them at https://github.com/beyond-all-reason/RecoilEngine/tree/master/cont/base/springcontent.
-Basecontent is due to have a major reorganization at some point in the near future.