Skip to content

the-drunken-cod/Symbols-n-Signs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

215 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Symbols'n'Signs

Collection of meaningful symbol items for Minecraft Java Edition and ways to display them.

Symbols'n'Signs banner showing off all symbol items and the Display Panel block entities


Introduction:

Symbols'n'Signs is a Minecraft mod for NeoForge and Fabric that adds a collection of symbol items to the game.
These symbols are designed to be meaningful and can be used for labeling purposes, like making Create's Redstone Link frequencies more recognizable.
They are regular items that are cheaply craftable and transmutable and have uniform and recognizable textures.

View the latest documentation here (Note: contains changed and unreleased content).


Installation:

You can visit the releases page, the Modrinth page, or the CurseForge page to download the latest version of Symbols'n'Signs.
Then simply place the downloaded JAR file into your Minecraft mods folder and launch the game with either NeoForge or Fabric.
For multiplayer, ensure the mod is installed on the server and all clients connecting to it. Automodpack can make this process easier.

Important

The Fabric version requires Cloth Config API to be installed as well.

Note

You will need either the NeoForge or Fabric mod loader installed to run the mod.
An easy way of doing this is by creating a modded game instance in a launcher like ATLauncher or MultiMC.


Development Notes:

  • This mod is still in early development, so expect major changes and breaking updates until the v1.0.0 release.
  • Developer docs can be found in the dev_docs.md file. They will contain more technical information.
  • DataGen JSONs (in neoforge/src/generated and fabric/src/generated) will be excluded from the repository until the v1.0.0 release. If you still want access to those files, you can either unzip the released JAR file, or set up the Java dev env and run the ./gradlew :neoforge:runData or ./gradlew :fabric:runData command.
  • If you want to contribute to the project, firstly thank you :), and secondly, please refer to the CONTRIBUTING.md file for guidelines and instructions.

Compatibility:

  • Sable / Create Aeronautics:
    • Block weight support

Attribution:


Modpack Policy

You are free to use Symbols'n'Signs in any modpacks; public or private :)
Just make sure you abide by our licenses, common sense, and the Minecraft EULA.
We would also appreciate a mention in the credits section of your modpack and a quick shout on our discussion board about your modpack (so we can check it out and play it ourselves!)
Please also consider reporting any issues or suggestions, so we can improve the mod for you and other players and have better compatibility with other mods.


Licenses

Code is licensed under the AGPL-3.0-only.
Original resources and assets in common/src/main/resources/ are licensed under MIT unless otherwise stated.


Disclaimers:

NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.