Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JTJutajoh authored Aug 16, 2021
1 parent 36aa833 commit afe7272
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,21 @@ This mod adds functional signs and comments with custom text. Also adds sign fun

Every sign added by this mod can have any text you want saved to it and it will display that text as a label on the map. You are also able to cycle the font size between 3 options, as well as set any color you want for each sign's label.

Comments are special buildings that cost nothing and place instantly, but even more importantly have some special Harmony patches allowing them to be placed on top of anything, including other buildings, natural walls, and even undiscovered/fogged areas. The Comment is the meat & potatoes of the mod.
Comments are special buildings that cost nothing and place instantly, but even more importantly have some special Harmony patches that allow them to be placed on top of anything, including other buildings, natural walls, and even undiscovered/fogged areas. The Comment is the meat & potatoes of the mod.

The core focus of this mod is the Comment, but I always like to decorate my colonies and thought some decorative signs would be fun to play with as well. I tried to cover the gamut of possible signs I could think of, but I am open to suggestions for more signs to add in future updates. I may also make modular additions with more signs related to specific themes in the future.
Note that existing signs may receive visual updates in the future as I'm not 100% happy with all of them, so don't be surprised if your signs look better when you load your save after an update.

Finally, I'd love to see the fun ways people use my signs, please don't hesitate to share screenshots of the creative ways you make use of the mod.

<h2>Known Issues</h2>

* Mods that modify camera zoom (Like Camera+) interfere with the settings to hide labels at certain zoom levels. Low priority but I will look into it eventually. Recommended to just enable the "All zoom levels" setting (Enabled by default).

<h2>Compatibility</h2>

* I anticipate no compatibility issues with other mods at all. <i>Please let me know</i> if you encounter any and I will look into it.
* <i>Sign Functionality for Modded Buildings:</i> Currently no modded buildings have sign functionality added, but it's a simple patch to add my `Dark.Signs.Comp_Sign` component to any Thing. Also simple for other mods to patch my component themselves. Please feel free to suggest mods that would benefit from it.
* <i>Sign Functionality for Modded Buildings:</i> Currently no modded buildings have sign functionality added, but it's a simple patch to add my `Dark.Signs.Comp_Sign` component to any Thing. Also simple for other mods to patch my component themselves. Please feel free to suggest mods that would benefit from it and I may add conditional patches for them.

<h2>Comments</h2>
The core vision of this mod was always the <b>Comment</b> sign, which is a special type of sign that places instantly and at no cost, plus it can be placed anywhere you want, including over buildings or undiscovered parts of the map (Such as the interior of a mountain).
Expand Down

0 comments on commit afe7272

Please sign in to comment.