https://github.com/trk20/aps-optimizer
APS Tetris Optimizer for From The Depths
https://github.com/trk20/aps-optimizer
csharp fromthedepths uno-platform
Last synced: 4 months ago
JSON representation
APS Tetris Optimizer for From The Depths
- Host: GitHub
- URL: https://github.com/trk20/aps-optimizer
- Owner: trk20
- License: mit
- Created: 2025-04-24T22:12:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-07T20:59:15.000Z (10 months ago)
- Last Synced: 2025-09-07T22:22:18.185Z (10 months ago)
- Topics: csharp, fromthedepths, uno-platform
- Language: C#
- Homepage:
- Size: 1.96 MB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
# APS Optimizer tool for From The Depths
This tool provides a simple, user-friendly method to easily generate density-optimized APS layouts for From The Depths.
---
## Features
- Support for 3, 4, and 5-clip tetris.
- Automatic turret layout templates, with the option to customize them for armour or extra space.
- Hard and soft symmetry enforcement options, including both rotational and reflexive symmetry.
- Export generated layouts directly to _From The Depths_ prefab file (`.blueprint`) for immediate use in-game.
- Choose the resulting prefab height, mapped automatically to the respective blocks (loader/clip length variants).
- Optionally include bottom layer of ejectors and ammo loaders in exported blueprint.
---
## Installation
#### Windows
1. Download `APS-Optimizer-{version}-windows-x64.zip` from the [latest release](https://github.com/trk20/APS-Optimizer/releases).
2. Extract the contents to a folder.
3. Run the contained `APS_Optimizer_V3.exe` executable
4. When Windows gives the "Windows protected your PC" popup click on "More Info" then "Run Anyways"
| _More Info_ | _Run Anyways_ |
| ----------------------------------------------------------- | ----------------------------------------------------------- |
|  |  |
This will prompt for the .NET 8.0 runtime if needed.
5. All done - you can move the folder (and all its contents) anywhere you feel and/or create a shortcut to the exe.
**Q:** Why does windows block the program?
**A:** The executable is "unsigned" - it doesn't have a special signature/certificate saying who made it, when, etc so windows can't tell whether or not it's safe. Reason it isn't signed is that that signing an exe is a pain - if you know better and think it's easy, feel free to create a PR for the workflow changes and I'll get it merged.
#### Linux
1. Download the relevant zip file from the [latest release](https://github.com/trk20/APS-Optimizer/releases) - `linux-x64` or `linux-arm64` depending on your cpu (if you don't know, you probably want the `linux-x64` version).
2. Extract the contents to a folder.
3. In terminal, navigate to the folder and run
`chmod +x APS_Optimizer_V3_Linux && ./APS_Optimizer_V3_Linux`
4. All done - the program should open.
---
# Usage
### Solver Parameters
#### Grid Editor (1)
Allows for toggling of individual cells between blocked and clear for fully custom templates.
#### Symmetry Selector (2)
Tells the solver to enforce the selected symmetry.
Chosen symmetry will be displayed on editor and result displays.
**Rotational (90/180 degrees)**
| Symmetry (Blank) | Example Solution |
| ------------------------------------------- | --------------------------------------------------------- |
|  |  |
**Reflexive (Vertical/Horizontal/Quadrants)**
| Symmetry (Blank) | Example Solution |
| ----------------------------------------- | ------------------------------------------------------- |
|  |  |
#### Soft vs Hard Symmetry (3)
Tells the solver whether or not to discard non-symmetric placements where the rotated or reflected shape would intersect itself.
| **Soft Symmetry** | **Hard Symmetry** |
| ------------------------------------------------------- | ------------------------------------------------- |
|  |  |
#### Template Preset Selector (4)
Automatically applies the selected template pattern on selection and resize.
| **Circle (Center Hole)** | **Circle (No Hole)** | **None** |
| --------------------------------------------- | ------------------------------------- | ------------------------------- |
|  |  |  |
#### Grid Dimensions (5)
Changes the width and height of the grids.
**Note:**
- Larger sizes will take longer to solve, especially above 21x21 for 4-clip.
#### Shape Selection (6)
Indicates which shape(s) the solver is allowed to use to generate a solution.
**Notes:**
- The cooler in 5-clip allows self-intersection to ensure optimal solutions.
- Mixing clip types is pretty much never optimal in FTD, so enable multiple at your own digression.
## Solving
While the solver is finding a solution, you'll be presented with an updating display of how long it's taking and the current iteration attempt number.
**Note:**
- Iterations in this case mean that the solver is allowing progressively less dense solutions. This will happen a fair number of times in certain situations, especially with hard reflexive symmetry, 4-clip, and 5-clip.
**Q:** Why can't there be a progress bar?
**A:** The time taken is _very_ unpredictable - a single solver setting can be the difference between 0.2s and 40s. If you figure out how to accurately estimate how long it will take, please consider making an issue with the exact details or submit a pull request.
## Exporting to FTD
When a solution is ready, you'll be able to use the export menu by pressing the Export Result button directly under the result display.
This will give you a pop-up menu displaying the number of each shape placed, the total material cost, and the block count for the generated prefab. You can select the result height using the target height (between 1 and 8 for 3-clip and 4-clip). If exporting 3 or 4 clip tetris, there will be an option to include the bottom ejector and ammo intake layer.
Pressing "Save" will allow you to navigate and save the prefab to your From The Depths prefab folder or a subfolder to allow placement in-game - located at `...\From The Depths\Player Profiles\{username}\PrefabsVersion2\`.
Now you can open it up in-game!
Voila!
**Note:**
- If From The Depths was already open, you might have to refresh the prefabs folder.
---
## Tips and extra info
- Enforcing symmetry will usually reduce the compute time, at the risk of missing better asymmetric solutions.
- 3-clip solutions are almost always faster to solve than 4-clip and 5-clip.
- Hard reflexive symmetry (Horizontal or Vertical) is recommended for 5-clip - the solution is almost always still optimal, it usually solves quite a bit faster, and the result looks nice :\)
- If you need more space for coolers/recoil absorbers/rail chargers, but don't care where, try using the different symmetries.
- If you want to leave room at the front of the turret for armour, or want a specific shape of center hole, just use the editor grid to toggle the cells before solving.
- 3-clip almost always finds optimal solutions with rotational symmetry, and at larger sizes reflexive symmetry is often still optimal.
---
## Contributing
Contributions are welcome! If you'd like to help improve this tool, please feel free to:
- **Report Issues:** If you find a bug _or_ you have a suggestion, please open an issue using the [GitHub Issues tab](https://github.com/trk20/APS-Optimizer/issues). Provide as much detail as possible, including steps to reproduce the bug if applicable.
- **Submit Pull Requests:** If you've fixed a bug or added a feature:
1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them.
4. Push to your branch.
5. Open a Pull Request against the main branch of this repository. Please provide a clear description of your changes.
6. Request a review.
Note: for making and testing changes to the codebase, you'll need to be able to run and debug Uno Platform apps - refer to their documentation [here](https://platform.uno/docs/articles/get-started.html) for setting that up.
## Acknowledgements
- Thanks to the developers of `cryptominisat5` for their [powerful SAT solver](https://github.com/msoos/cryptominisat) - this tool uses it directly to do the brunt of the optimization. Suffice it to say this tool would not be nearly as good without this fantastic SAT solver.
- Thanks to **sascha** on stackoverflow for their fantastic [answer on a polynomio grid-packing question](https://stackoverflow.com/a/47934736) that served as the basis for this tool's core logic.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.