Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New LT Gamer's Guide: Part 2 #2510

Merged
merged 4 commits into from
Jan 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 40 additions & 22 deletions docs/Contributing/style-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,48 +104,66 @@ interface markup elements to bring attention to something or make it more obviou
to do. Interpreted text roles are simply a code word surrounded by a colon on both sides and the text you want
to alter is placed inside back-ticks.

* :literal:`:doc:` -- Doc is used to create a hyperlink reference between documents in the documentation
* :literal:`:doc:` --- Doc is used to create a hyperlink reference between documents in the documentation
system.
* :literal:`:ref:` -- Create a cross-reference link to an anchor in another document. This is similar to

* :literal:`:ref:` --- Create a cross-reference link to an anchor in another document. This is similar to
:literal:`:doc:`, except it allows you to go to a specific location within a page, instead of the top of the
page. To use :literal:`:ref:`, you add an anchor in a page such as :literal:`.. _My Anchor:` and then refer
page. To use :literal:`:ref:`, you add an anchor in a page such as :literal:`.. _My-Anchor:` and then refer
to it like this: :literal:`:ref:`My Anchor``. Notice that the anchor has an underscore at the beginning.
This is required for sphinx to recognize it. Also notice the use of the anchor in :literal:`:ref:` leaves
the underscore off.
* :literal:`:numref:` -- Create a cross-reference to a named figure.
* :literal:`:table:` -- Create a named table reference. Place an anchor (e.g. :literal:`.. _My Anchor:`) above
to enable :literal:`:numref:`.
* :literal:`:figure:` -- Create a named figure reference. Place an anchor (e.g. :literal:`.. _My Anchor:`)

* :literal:`:numref:` --- Create a cross-reference to a named figure.

* :literal:`:table:` --- Create a named table reference. Place an anchor (e.g. :literal:`.. _My-Anchor:`)
above to enable :literal:`:numref:`.

* :literal:`:figure:` --- Create a named figure reference. Place an anchor (e.g. :literal:`.. _My Anchor:`)
above to enable :literal:`:numref:`.
* :literal:`:emphasis:` -- Emphasis is used to :emphasis:`bring attention to something`.
* :literal:`:file:` -- File is used for file names and paths such as :file:`~/.local/share/freeciv21/saves`.
* :literal:`:guilabel:` -- GUI Label is used to bring attention to something on the screen like the

* :literal:`:emphasis:` --- Emphasis is used to :emphasis:`bring attention to something`.

* :literal:`:file:` --- File is used for file names and paths such as :file:`~/.local/share/freeciv21/saves`.

* :literal:`:guilabel:` --- GUI Label is used to bring attention to something on the screen like the
:guilabel:`Next` button on the installer wizard.
* :literal:`:literal:` -- Literal is used when you want to note a text element in its raw form. This is

* :literal:`:literal:` --- Literal is used when you want to note a text element in its raw form. This is
equivalent to using two back-ticks: ````text````.
* ``math`` and ``.. math::`` -- Used to insert mathematics, see `Formulas`_.
* :literal:`:menuselection:` -- Menu Selection is used to give the path of menu clicks such as

* :literal:`math` and :literal:`.. math::` --- Used to insert mathematics, see `Formulas`_.

* :literal:`:menuselection:` --- Menu Selection is used to give the path of menu clicks such as
:menuselection:`Game --> Local Options`. To denote submenus, use a test arrow like this: :literal:`-->`
between the selection items.
* :literal:`:strong:` -- Strong is used to :strong:`bold some text`. A good use of :literal:`:strong:` is to

* :literal:`:strong:` --- Strong is used to :strong:`bold some text`. A good use of :literal:`:strong:` is to
highlight game elements.
* :literal:`:title-reference:` -- Title Reference is used notate a :title-reference:`title entry` in the

* :literal:`:term:` --- Term is used to cross-reference to an entry in the :doc:`/glossary`.

* :literal:`:title-reference:` --- Title Reference is used notate a :title-reference:`title entry` in the
in-game help or to refer to a page in the documentation without giving an actual hyperlink reference
(see :literal:`:doc:` above).
* :literal:`.. versionadded::` -- Used at the paragraph level to document the first version in which a feature
was added.

* :literal:`.. versionadded::` --- Used at the paragraph level to document the first version in which a
feature was added.

The docutils specification allows for custom Interpreted Text Roles and we use this feature. The docutils
documentation on this feature is available here:
https://docutils.sourceforge.io/docs/ref/rst/directives.html#custom-interpreted-text-roles

* :literal:`:unit:` -- This provides an opportunity to highlight a Freeciv21 unit, such as the
:unit:`Musketeer`
* :literal:`:improvement:` -- This provides an opportunity to highlight a Freeciv21 building or city
* :literal:`:unit:` --- This provides an opportunity to highlight a Freeciv21 unit, such as the
:unit:`Musketeer`.

* :literal:`:improvement:` --- This provides an opportunity to highlight a Freeciv21 building or city
improvement, such as the :improvement:`Granary`.
* :literal:`:wonder:` -- This provides an opportunity to highlight a Freeciv21 small or great wonder, such as

* :literal:`:wonder:` --- This provides an opportunity to highlight a Freeciv21 small or great wonder, such as
the :wonder:`Pyramids`.
* :literal:`:advance:` -- This provides an opportunity to highlight a Freeciv21 technology advance, such as

* :literal:`:advance:` --- This provides an opportunity to highlight a Freeciv21 technology advance, such as
:advance:`Ceremonial Burial`.

Admonition Directives
Expand Down
2 changes: 2 additions & 0 deletions docs/Manuals/Server/options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -943,6 +943,8 @@ To place a setting value on any of these settings use the ``/set <option-name> <
* ``HORIZONTAL``: Horizontal placement. Players of the same team will be placed horizontally.
* ``VERTICAL``: Vertical placement. Players of the same team will be placed vertically.

.. _server-option-techleak:

``techleak``
:strong:`Default Value (Min, Max)`: 100 (0, 300)

Expand Down
2 changes: 2 additions & 0 deletions docs/Playing/LT-Guide/first-turn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ to get you started:
* Once the first 5 cities are planted, you need to expand as fast as possible with more :unit:`Settlers`!
Refer to the **Settler Race** section below.

.. _lt-guide-city-planning:

City Planning
=============

Expand Down
1 change: 1 addition & 0 deletions docs/Playing/LT-Guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ online against other human players.
.. toctree::
intro.rst
first-turn.rst
twenty-turns.rst
:maxdepth: 2
23 changes: 12 additions & 11 deletions docs/Playing/LT-Guide/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,17 @@
Introduction
************

The Longturn community maintains and plays three specialized rulesets: Longturn Tradidional (LTT), Longturn
Experimental (LTX), and Royale. The LTT and LTX rulesets are losely based on the Civ2Civ3 ruleset as it existed
"way back" in legacy Freeciv v2.0 days. Royale is new as of 2023.
The Longturn community maintains and plays three specialized rulesets: Longturn Traditional (LTT), Longturn
Experimental (LTX), and Royale. The :term:`LTT` and :term:`LTX` rulesets are loosely based on the Civ2Civ3
ruleset as it existed "way back" in legacy Freeciv v2.0 days. Royale is new as of 2023.

Here are some generalized notes related to the three rulesets:

* :strong:`LTT`: There are actually two versions: LTT and LTT2. LTT is the original standard ruleset played
across many games, including `The League <https://longturn.net/game/TheLeague/>`_. In 2024, we created an
updated LTT2 based on input from the community as well as the :doc:`game admin's </Contributing/game-admin>`
experience. LTT2 should be considered a logical evolution of LTT.
* :strong:`LTT`: There are actually two versions: :term:`LTT` and :term:`LTT2`. :term:`LTT` is the original
standard ruleset played across many games, including `The League <https://longturn.net/game/TheLeague/>`_.
In 2024, we created an updated :term:`LTT2` based on input from the community as well as the
:doc:`game admin's </Contributing/game-admin>` experience. :term:`LTT2` should be considered a logical
evolution of :term:`LTT`.

.. note::
LTT2 is considered the default stable ruleset. The League still plays LTT and will change to LTT2 when
Expand All @@ -31,8 +32,8 @@ Here are some generalized notes related to the three rulesets:

* :strong:`Royale`: This is a newer ruleset that takes many thoughts from LTT and tries to create a simpler
set of rules for brand new Longturn players. The general idea is to create a set of rules that can be played
by experieced and new players, with enough slack that new players will not get overwhelmed if they make
gameplay mistakes.
by experienced and new players, with enough slack that new players will not get overwhelmed if they make
game-play mistakes.


.. _lt-game-guide-other-tutorials:
Expand All @@ -50,7 +51,7 @@ Here are links to some other tutorials. Your mileage may vary with some of them.
Terrain, Cities, Economy, Units, Combat, Diplomacy, Government, Technology, Wonders, and Buildings. Gives a
good overview of how the varying elements of a game work if you are new to Freeciv or Freeciv21.
* `Multiplayer Game Manual on Freeciv Fandom <https://freeciv.fandom.com/wiki/Multiplayer_Game_Manual>`_.
* `Multiplayer Ruleset (cheatsheet) on Freeciv Fandom <https://freeciv.fandom.com/wiki/Multiplayer_Ruleset>`_.
* `Multiplayer Ruleset (cheat-sheet) on Freeciv Fandom <https://freeciv.fandom.com/wiki/Multiplayer_Ruleset>`_.
* `How to Play Freeciv on Freeciv Fandom <https://freeciv.fandom.com/wiki/How_to_Play>`_.
* `The Art of Freeciv on Freeciv Fandom <https://freeciv.fandom.com/wiki/The_Art_of_Freeciv_2.1>`_
* `How to Join a Longturn Game on Longturn Blog <https://longturn21.blogspot.com/p/how-to-join-longturn-game.html>`_.
Expand All @@ -76,7 +77,7 @@ A Note About Tilesets
=====================

Longturn games will generally use one of two map topologies: squares or hexes. Some players love squares, and
hate hexes. Some players are the opposite! Longturn game admins will annouce up front what map topology a game
hate hexes. Some players are the opposite! Longturn game admins will announce up front what map topology a game
will use.

For squares: The shipped Amplio2 tileset is the default. It is in an isometric direction. There are two
Expand Down
Loading
Loading