Differences

This shows you the differences between two versions of the page.

--- usage:forks [2021-11-04 15:56] – Fix broken link 56independent
+++ usage:forks [2024-02-01 15:46] (current) – ywang
@@ Line 1: / Line 1: @@
-====== Forks ======
+====== Branches and forks ======
-There exist forks of AdvTrains, and these forks add or remove functionality. Listed are the websites of each fork:
+Please note that **the master branch is the only branch that is officially supported**. Use other branches at your own risk. Discussions on other branches should *explicitly* state the use of that branch. This page does not imply any support for or negativity against the branches and forks listed here.
+Branches are generally created to add certain features and test them before the changes go upstream. These can be fetched from the same repository. Advtrains has the following branches:
 ^ Name ^ Status ^ Description ^
-| [[http://git.bananach.space/advtrains.git/log/|Master]] | Active | The main, recommended branch for new users. |
+| **master** | Upstream | Upstream branch |
-| [[http://git.bananach.space/advtrains.git/log/?h=atcjit|ATCjit]] | ? | ? |
+| doc    | Moved | working on better, up-to-date documentation written in LaTeX (//ywang//); the manual has been moved to [[https://codeberg.org/y5nw/advtrains-doc|a dedicated repository]] |
-| [[http://git.bananach.space/advtrains.git/log/?h=l10n|Localization]] | Inactive | A branch which is suspected to have the purpose of localizing AdvTrains. |
+| l10n   | Semi-active (WIP)  | Internationalization and translation efforts (//ywang; translations contributed by Tanavit et al//) |
-| [[http://git.bananach.space/advtrains.git/log/?h=luaatcdebug|LuaATC debug]] | Active | Designed for debugging LuaATC. |
+| new-ks | Semi-active (testing needed)  | Improvements and extensions to the Ks signalling system and related features (//ywang//) |
-| [[http://git.bananach.space/advtrains.git/log/?h=master_old|Old Master]] | Dead | The old branch of master, now dead likely came here from a github migration |
+| route_prog_rework | Semi-Active (WIP) | Overhaul of the route programming system + in-game railway mapping (//orwell//, occasional progress when there is time) |
-| [[http://git.bananach.space/advtrains.git/log/?h=new-ks|New Ks]] | Active but deprecated (possibly) | Branch with a distant signalling, but has been in weird waters |
+| atcjit   | Inactive (WIP) | "Compiles" ATC commands to Lua code (//ywang//) |
-| [[http://git.bananach.space/advtrains.git/log/?h=profiler|Profiler]] | Dead | Adds a profiler. |
+| profiler | Inactive | Adds a profiler. When advtrains is being profiled the next time, this branch can be reused. |
-| [[http://git.bananach.space/advtrains.git/log/?h=rlsafety|Rail Safety]] | Inactive | A fork which adds rail safety |
+| trainhud-unifont | Semi-active (WIP) | Improvements to the graphical train HUD |
-| [[http://git.bananach.space/advtrains.git/log/?h=trainhud|Train HUD]] | Inactive | A fork for the development of the new train HUD (?) |
+| luaatcdebug | Unittests | **DO NOT USE FOR PRODUCTION**: unsafe LuaATC environment to facilitate unit testing |
-| [[http://git.bananach.space/advtrains.git/log/?h=trainhud-unifont|Train HUD unifront]] | Inactive | See above. |
+| unittests-srht | Unittests (WIP) | Unit tests for various components of advtrains |
-| [[http://56i.duckdns.org/dokuwiki/doku.php?id=proposals:hsf|HSF]] | Planning | More a seperate mod then a fork, adds High Speed Rails to any world, with some strict limitations. |
-Anything with a commit in the last month is considered active, in the last year inactive, and before the current year dead. Anything in "Planning" is not in development, but is still being made in terms of a plan.
+Advtrains 1.x (former 'master_old' branch) can now be retrieved from the ''release-1.x'' tag. Versions since 2.1.2 (inclusive) are also tagged.
+The following table includes known forks. Discussions on forks should take place on the corresponding bugtracer or forum thread.
+^ Name ^ Status ^ Description ^
+| [[http://56i.duckdns.org/dokuwiki/doku.php?id=proposals:hsf|HSF]] | Planning | More a seperate mod then a fork, adds High Speed Rails to any world, with some strict limitations. |