Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BluSunrize committed Jun 9, 2024
1 parent 861fc72 commit a05701b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 24 deletions.
31 changes: 8 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,13 @@
<img src="src/main/resources/assets/gastronomyworks/logo.png" width="100" height="100">

Installation information
=======
# Gastronomy Works

This template repository can be directly cloned to get you started with a new
mod. Simply create a new repository cloned from this one, by following the
instructions at [github](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
A small addon to Immersive Engineering which adds a variety of food items.
All foods added rely on industrial processing to make them, primarily using the mixer and bottling machine.

Once you have your clone, simply open the repository in the IDE of your choice. The usual recommendation for an IDE is either IntelliJ IDEA or Eclipse.
Among the added foods are various baked goods (baguette, sour dough, cake) but also canned goods like stew!

> **Note**: For Eclipse, use tasks in `Launch Group` instead of ones founds in `Java Application`. A preparation task must run before launching the game. NeoGradle uses launch groups to do these subsequently.
## Downloads
[Modrinth](https://modrinth.com/project/gastronomy-works)

If at any point you are missing libraries in your IDE, or you've run into problems you can
run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean` to reset everything
{this does not affect your code} and then start the process again.

Mapping Names:
============
By default, the MDK is configured to use the official mapping names from Mojang for methods and fields
in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this
license, if you do not agree with it you can change your mapping names to other crowdsourced names in your
build.gradle. For the latest license text, refer to the mapping file itself, or the reference copy here:
https://github.com/NeoForged/NeoForm/blob/main/Mojang.md

Additional Resources:
==========
Community Documentation: https://docs.neoforged.net/
NeoForged Discord: https://discord.neoforged.net/
[CurseForge](https://minecraft.curseforge.com/projects/gastronomy-works/files)
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ mod_license=MIT License
mod_version=0.5.0
mod_group_id=blusunrize.gastronomyworks
mod_authors=BluSunrize
mod_description=Adding various cooking recipes to Immersive Engineering.
mod_description=Adding various cooking recipes to Immersive Engineering!
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a05701b

Please sign in to comment.