Skip to content

Mapping Tool Section Redraft #11

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Mapping Tool Section Redraft #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e4db838
WIP1
CatTanker May 24, 2024
29a1943
change link to cncnet
CatTanker May 19, 2025
eac447e
small edits and removing monitoring
CatTanker May 19, 2025
7e0194a
spelling fixes
CatTanker May 19, 2025
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
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,5 @@ dmypy.json

# Pyre type checker
.pyre/

*.kate-swp
32 changes: 29 additions & 3 deletions docs/core_editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
This section covers the core editors that have been an essential part of mapping for the past 20+ years. I highly recommend checking the 'Modern Options' page as well, as this will significantly improve the user experience of the following editors, and offer an alternative.

The 'Assistive Tools' page is fairly self explanatory. These tools cannot replace a core editor, but may significantly help your workflow through the utilities they provide.
This section covers the core editors that have been an essential part of mapping for the past 20+ years.

### [FA2] Final Alert 2:

Expand All @@ -27,3 +25,31 @@ The Tiberian Sun Client [TSC] also includes a build.
| Patched FS [Vanilla] | [PPM - Forum](https://ppmforums.com/topic-47355/finalsun-101-patches/) |
| "Toolkit" + Clutter | [CnCNet - Forum](https://forums.cncnet.org/topic/6720-final-sun-complete-fixed/) |
| Tiberian Sun Client | [ModDB](https://www.moddb.com/mods/tiberian-sun-client) |

This section covers improving the core experience of mapping. This includes both modifications to the original editors, and the alternatives that the community has made since, specifically the World Altering Editor.

### Editor Modifications:
#### DDraw Renderer

Instead of using the system DDraw, FA2 and FS can instead use a local proxy DDraw.dll, improving the editor's speed considerably, which is especially useful for resource-heavy maps.
Several of the *patched* map editors have this included but it is often in a subfolder such as "ForWindows10", containing a pre-configured setup. if you want an un-configured setup for unknown reasons, or simply want to know more about the wrapper, check the unconfigured link below.

| Topic | Source + Link |
| ------------ | ------------- |
| Unconfigured |[BitPatch](http://bitpatch.com/ddwrapper.html)|
| Pre-Configured|[PPM](https://ppmforums.com/download.php?id=72031&sid=5b50cb3c1696d792adb195e4360b46fd)|

#### Dark and Custom themes

Assuming you use the Sp version of the editor, it is certainly possible to modify the theme. This comes with a risk however, as on windows you have to modify your entire system's theme in order to achieve this, and if you install the wrong theme for your windows version, your windows updates and therefore becomes incompatible with the theme you are using, or of course simply mess something up you could easily break your system and be left to the mercy of restore points or a fresh boot. There are a number of windows 'ricing' tutorials and lists online, but a lot of recommendations from major publishers seem to only use what windows 10+ already allows you to do, which doesn't really help you. I found and recommend [this reddit post](https://www.reddit.com/r/Windows10/comments/168y7dn/ultimate_simplified_guide_how_to_make_windows_10/) for the basics as it describes most options available for modernising theming 10, with a lot being applicable to Windows 11 as well. While you are of course free to read the entire section, you should focus on the `Before Starting` and the themes section. If you decide to further rice your system, i [recommend this, as although it focuses on Windows 11 a lot of the tools work with 10.](https://github.com/twonth/winning-at-windows)

I have included below an example of what FA2 looks like using dark theme from [rectify11](https://rectify11.net) on Windows 11, which is available for free. Sadly the Windows 11 elements carry over, including spacings in dropdowns, and the extremely dark colour scheme doesn't sit too well.
![Rectify11 FA2](Assets/win11_themed.png)
---
Another example is After Dark CC Blue, provided by SCIPCION on Windows 10. I believe this is no longer available for free however.
![AfterDarkCC](Assets/after_dark_cc.png)
---
This example uses [fluent from niivu's Windows 10 Themes](https://github.com/niivu/Windows-10-themes). The creator also has a large collection of other windows 10 & 11 [themes](https://www.deviantart.com/niivu/gallery) that you can experiment with as well.
![Win10_Fluent](Assets/fluent.png)

Ultimately it is your decision if you wish to risk modifying windows in such a way, especially with WAE as a modern alternative. I have also written advice on applying a dark theme in [linux](linuxtools.md), however the options are more limited.
65 changes: 23 additions & 42 deletions docs/modern_editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,39 @@
This section covers improving the core experience of mapping. This includes both modifications to the original editors, and the alternatives that the community has made since, specifically the World Altering Editor.

### Editor Modifications:
#### DDraw Renderer
<!---#| Github |[Link](https://github.com/FunkyFr3sh/cnc-ddraw)| -->
# World Altering Editor <br />
Author: Rampastring + Contributors <br />
Description: The World Altering Editor (WAE) is an open source replacementation to the traditional editors. Unlike the originals, it is built using a modern code base.
Formerly known as the DTA Scenario Editor, as it was built for [Dawn of the Tiberium Age](https://www.moddb.com/mods/the-dawn-of-the-tiberium-age), it has since been growing in compatability for TS/YR.
A release for [TS Client](https://www.moddb.com/mods/tiberian-sun-client) and YR both available on the the releases page.

The editor requires the latest dotnet desktop runtime to operate, and has heightened requirements, but does have a lot of major benefits (listed below).

Instead of using the system DDraw, FA2 and FS can instead use a local proxy DDraw.dll, improving the editor's speed considerably, which is especially useful for resource-heavy maps.
Several of the *patched* map editors have this included but not in use, so check your map editor's folder as the files may already exist, such as in a "ForWindows10" folder, containing a pre-configured setup. if you want an un-configured setup for unknown reasons, or simply want to know more about the wrapper, check the unconfigured link below. I also included a direct download, although i have lost which thread this is on so i am unable to verify if it is the latest download.

| Topic | Source + Link |
| ------------ | ------------- |
| Unconfigured |[BitPatch](http://bitpatch.com/ddwrapper.html)|
| Pre-Configured|[PPM](https://ppmforums.com/download.php?id=72031&sid=5b50cb3c1696d792adb195e4360b46fd)|

#### Dark and Custom themes
| World Altering Editor | [Github - Main Page](https://github.com/CnCNet/WorldAlteringEditor) |
| World Altering Editor | [Github - Releases](https://github.com/CnCNet/WorldAlteringEditor/releases) |
| Mod Haven Channel | [Discord](https://discord.gg/k4SVuMm) |

Assuming you use the Sp version of the editor, it is certainly possible to modify the theme. This comes with a risk however, as on windows you have to modify your entire system's theme in order to achieve this, and if you install the wrong theme for your windows version, your windows updates and therefore becomes incompatible with the theme you are using, or of course simply mess something up you could easily break your system and be left to the mercy of restore points or a fresh boot. There are a number of windows 'ricing' tutorials and lists online, but a lot of recommendations from major publishers seem to only use what windows 10+ already allows you to do, which doesn't really help you. I found and recommend [this reddit post](https://www.reddit.com/r/Windows10/comments/168y7dn/ultimate_simplified_guide_how_to_make_windows_10/) for the basics as it describes most options available for modernising theming 10, with a lot being applicable to Windows 11 as well. While you are of course free to read the entire section, you should focus on the `Before Starting` and the themes section. If you decide to further rice your system, i [recommend this, as although it focuses on Windows 11 a lot of the tools work with 10.](https://github.com/twonth/winning-at-windows)
Videos demonstating older versions of WAE:

I have included below an example of what FA2 looks like using dark theme from [rectify11](https://rectify11.net) on Windows 11, which is available for free. Sadly the Windows 11 elements carry over, including spacings in dropdowns, and the extremely dark colour scheme doesn't sit too well.
![Rectify11 FA2](Assets/win11_themed.png)
---
Another example is After Dark CC Blue, provided by SCIPCION on Windows 10. I believe this is no longer available for free however.
![AfterDarkCC](Assets/after_dark_cc.png)
---
This example uses [fluent from niivu's Windows 10 Themes](https://github.com/niivu/Windows-10-themes). The creator also has a large collection of other windows 10 & 11 [themes](https://www.deviantart.com/niivu/gallery) that you can experiment with as well.
![Win10_Fluent](Assets/fluent.png)
<iframe width="560" height="315" src="https://www.youtube.com/embed/jIcr3nCqx7M?si=sHyZGT08GEpVWEnU" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

Ultimately it is your decision if you wish to risk modifying windows in such a way, especially with WAE as a modern alternative. I have also written advice on applying a dark theme in [linux](linuxtools.md), however the options are more limited.
<iframe width="560" height="315" src="https://www.youtube.com/embed/RIgVMWZy80I" title="World Altering Editor - A new map editor coming to RotE" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>


<!---#| Github |[Link](https://github.com/FunkyFr3sh/cnc-ddraw)| -->
## Highly Configurable

### World Altering Editor : <br />
Author: Rampastring + Contributors <br />
Description: The World Altering Editor (WAE) is an open source replacement to the traditional editors. unlike the originals, it is built using a modern code base, and as a result of being open source it does not require the use of dll injection to improve.
Formerly known as the DTA Scenario Editor, as it was built for [Dawn of the Tiberium Age](https://www.moddb.com/mods/the-dawn-of-the-tiberium-age), it has since been growing in compatability for TS/YR.
A release for TSClient and Vanilla YR both available on the the releases page. As of v0.9.6 the editor now has a voxel renderer, meaning that the editor can effectively replace FA2 for all quality PCs using win7 or later,
although it is arguably still behind in a few areas. As of version 1.0, the editor will require dotnet runtime 8, and is only built for Windows, although running it through modern wine solutions are an option for linux.
The World Altering Editor has been built with mods and the cncnet client in mind, and operates on a highly configurable structure of ini config files. This allows for the editor to support a wide range of mod structures, including that of TSClient where MIX and INI files are split into several subfolders, and that of the "put it all in the root" structure of YR. MIX load orders can be configured easily, and there are rules/art override files available. Any theater can be defined, so mods which modify the theaters available no longer need to hex edit and ship multiple FA2/Fs installations with their mod.

I **highly** recommend trying this editor out, as it contains a lot of new features that would be out of scope for FA2/FS. Check the [releases page](https://github.com/Rampastring/WorldAlteringEditor/releases) for an up-to-date YR and TSClient build.
The releases page also includes a full changelog, which at the moment is the most comprehensive list of features.
[ Example of the config folder + sample INI ]

| Topic | Source + Link |
| ------------ | ------------- |
| World Altering Editor | [Github - Main Page](https://github.com/Rampastring/TSMapEditor) |
| World Altering Editor | [Github - Releases](https://github.com/Rampastring/TSMapEditor/releases) |
| Mod Haven Channel | [Discord](https://discord.gg/k4SVuMm) |
## Interface Features

<iframe width="560" height="315" src="https://www.youtube.com/embed/jIcr3nCqx7M?si=sHyZGT08GEpVWEnU" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
A growing volume of interface features have been developed. One of the more evident examples is a zoom in/out function, which is greatly missed in the WW2.5D series of map editors. The editor also includes a search tool so you can find a specific item much easier, better catagorized lists, and a configurable LAT panel. Furthermore, there is also a map-wide overlay option, which can display a selected image file stretched across the entire map, which is extremely useful when combined with the zoom tools as map designs can easily be traced.

<iframe width="560" height="315" src="https://www.youtube.com/embed/RIgVMWZy80I" title="World Altering Editor - A new map editor coming to RotE" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
[Video of zooming in/out + searching + overlay]

### Incomplete / WIP:
Mostly remains here as an archive of github links that *once* existed. Might be a useful reference one day.
Relert ++ : <https://github.com/secsome/relertplusplus> <br />
Relert Sharp Private Thread : <https://github.com/FrozenFog/relertsharp> <br />
https://github.com/FrozenFog/rs-dev-public-snapshot/blob/dev/pic/preview-migdal.png
https://github.com/FrozenFog/rs-dev-public-snapshot
## New Tools
There are also several automative tools available for WAE, including a configurable terrain generator to decorate natural environments, a WIP cliff drawer, and the possibilities of user-made scripts that can perform advanced tasks, such as smoothing out water tiles. The editor can also draw complex tunnels, which do not break unlike the unpatched FA2's tunnels, has a check distance tool that can follow pathfinding, and allows users to configure what is copied and deleted.

[Example of the terrain generator + Cliff Drawer]
29 changes: 2 additions & 27 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ nav:
# - Home: home.md redundant, since index.md seems to be hardcoded
- Landing Page: index.md
- 'Mapping Tools':
- 'Core Tools': 'core_editors.md'
- 'Modern Options': 'modern_editors.md'
- 'Modern Editor': 'modern_editors.md'
- 'Original Editor': 'core_editors.md'
- 'Assistive Tools': 'additional_tools.md'
- Map Resources: resources.md
- 'Linux Resources':
Expand All @@ -84,32 +84,7 @@ nav:
- 'WineTricks' : 'winetricks.md'
- 'Support and Compatability' : 'linuxsupport.md'
- 'Editor Tool Compatability' : 'linuxtools.md'
extra:
analytics:
provider: google
property: G-Y88LQ85YZ1
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Help us improve this page by commenting any issues onto GitHub.
consent:
title: Cookie consent
description: >-


We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
Expand Down