|
1 | | -[](https://github.com/fgardt/factorio-mod-template/actions/workflows/release.yml) |
| 1 | +[](https://github.com/notnotmelon/fluid-memory-storage/actions/workflows/release.yml) |
2 | 2 | <!-- ^======[REPLACE THIS]======^ ^======[REPLACE THIS]======^ --> |
3 | 3 |
|
4 | | -# factorio-mod-template |
5 | | - |
6 | | -A small Factorio Mod template which also contains GitHub Actions for automatic changelog generation, packaging and releasing to the [Factorio Mod Portal](https://mods.factorio.com) |
7 | | - |
8 | | -# How it works |
9 | | - |
10 | | -This template uses [semantic-release](https://github.com/semantic-release/semantic-release) to automate the changelog generation aswell as packaging and releasing the mod. \ |
11 | | -Changelog generation is done with [this preset](https://github.com/fgardt/conventional-changelog-conventionalcommits-factorio) while packaging and releasing is done with [this plugin](https://github.com/fgardt/semantic-release-factorio). \ |
12 | | -Additionally the GitHub Action will also create a release in your repository on GitHub itself. |
13 | | - |
14 | | -Once you push new commits to the main branch the release action will trigger. \ |
15 | | -First it scans all your commit messages to figure out what the new version should be and what to put into the changelog. \ |
16 | | -To make this possible you need to use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). |
17 | | - |
18 | | -| Commit type | Changelog section | |
19 | | -| --------------------------- | ----------------- | |
20 | | -| `feat` or `feature` | `Features` | |
21 | | -| `fix` | `Bugfixes` | |
22 | | -| `perf` or `performance` | `Optimizations` | |
23 | | -| `compat` or `compatibility` | `Compatibility` | |
24 | | -| `balance` | `Balancing` | |
25 | | -| `graphics` | `Graphics` | |
26 | | -| `sound` | `Sounds` | |
27 | | -| `gui` | `Gui` | |
28 | | -| `info` | `Info` | |
29 | | -| `locale` | `Locale` | |
30 | | -| `translate` | `Translation` | |
31 | | -| `control` | `Control` | |
32 | | -| `other` | `Changes` | |
33 | | - |
34 | | -Because a push to the main branch triggers the release action it is recommended to work on a separate branch until your work is done and then merge that branch into main to release it. \ |
35 | | -_Or you just work locally and if you want to release you push your changes to main, up to you how you want to do it ;)_ |
36 | | - |
37 | | -# How to use |
38 | | - |
39 | | -## Repository setup |
40 | | - |
41 | | -Click the `Use this template` button and create your own repository. |
42 | | - |
43 | | -Once you have your new repository you need to add a Factorio token as a GitHub Actions secret so that the mod releasing can work. \ |
44 | | -To get the token go to [Factorio's website](https://factorio.com/login) and login with your account. \ |
45 | | -Then you need to go to your [profile](https://factorio.com/profile) and generate a new API key. \ |
46 | | -The API key needs `Upload Mods`, `Publish Mods` and `Edit Mods` permissions. Copy the generated key. |
47 | | - |
48 | | -Now you need to go to your repository settings > `Secrets and variables` > `Actions` and add a new Repository secret called `FACTORIO_TOKEN` with your copied key as the secret. |
49 | | - |
50 | | -## Mod setup |
51 | | - |
52 | | -- Swap out the [`LICENSE`](LICENSE) to your own liking _**(especially change out my name for yours)**_ |
53 | | -- Populate the [`info.json`](info.json) file with correct values _(the `version` field gets updated automatically)_ |
54 | | -- Add the corresponding text into [`locale.cfg`](locale/en/locale.cfg) |
55 | | -- Add a `thumbnail.png` to the root of the repository _([ideally 144x144px](https://wiki.factorio.com/Tutorial:Mod_structure#Files))_ |
56 | | - |
57 | | -# Misc |
58 | | - |
59 | | -## How the packaging works |
60 | | - |
61 | | -The [`semantic-release-factorio` plugin](https://github.com/fgardt/semantic-release-factorio) uses the `git archive` command to package the mod. \ |
62 | | -That way you can specify what folders / files to exclude from your packaged mod by specifying them in [`.gitattributes`](.gitattributes). |
63 | | - |
64 | | -If you want to locally test packaging of your mod you can run the following command: |
65 | | -```sh |
66 | | -git archive --format zip --prefix [YOUR-MOD-NAME]/ --worktree-attributes --output [YOUR-MOD-NAME]_[VERSION].zip HEAD |
67 | | -``` |
68 | | - |
69 | | -## Need help? |
70 | | - |
71 | | -Checkout the [official Factorio Discord](https://discord.gg/factorio) and check the pins in the `#mod-making` channel. \ |
72 | | -There is also the [Lua API documentation](https://lua-api.factorio.com/latest/) and the [modding section in the wiki](https://wiki.factorio.com/Modding). |
| 4 | +### Adds a container that can store an infinite amount of any fluid |
| 5 | + |
| 6 | +Graphics from kaueNP |
| 7 | +Compatible with all mods |
| 8 | +Packed unit graphic from calcwizard's Packing Tape (MIT). https://mods.factorio.com/mod/packing-tape |
| 9 | + |
| 10 | + |
| 11 | +### Packed units |
| 12 | +Q: What happens when a unit is broken? Are my fluids lost? |
| 13 | + |
| 14 | +A: Fluids are not lost. Fluids are "packed" inside the item and are recovered when you place the unit back down. |
| 15 | + |
| 16 | +Warning: If a fluid unit is destroyed (biters, nuke, or otherwise) then you will NOT get a packed unit and your items will be lost! |
| 17 | + |
| 18 | +### Power |
| 19 | +The fluid unit requires power to function! |
| 20 | +The power usage is equal to: |
| 21 | +1MW + (ceil(fluid amount / 1000) ^ 0.35) * 300kW |
| 22 | +This can be changed in mod settings |
| 23 | + |
| 24 | +If it runs out of power, then it will not accept any more fluids until it gets power again. |
| 25 | + |
| 26 | + |
| 27 | + |
| 28 | +### Circuits |
| 29 | +Memory units can connect to the circuit network! Simply attach a red or green wire to the circle on the top of the container. |
| 30 | +This will read both the type and amount of whatever you have stored in the unit. |
| 31 | + |
| 32 | +Circuit signals in Factorio can only go up to 2147483647. If you happen to have more items than this stored in a memory unit, then the signal will still only display as 2.1G. |
| 33 | + |
| 34 | +### UPS |
| 35 | +This mod is optimized. Should have a very minor impact on your UPS. |
| 36 | + |
| 37 | +### Graphics |
| 38 | +The color of the unit is based on the fluid inside! |
| 39 | + |
| 40 | +### Custom GUI |
| 41 | +Fluid units have a custom gui as of v1.4.0! |
| 42 | + |
| 43 | + |
| 44 | +### Addon |
| 45 | +This mod is the official add-on to the Memory Storage mod, but they can work separately if you don't need both. |
| 46 | +https://mods.factorio.com/mod/deep-storage-unit |
| 47 | + |
| 48 | + |
| 49 | +### [> Check out my other mods! <](https://mods.factorio.com/user/notnotmelon) |
0 commit comments