Skip to content

Commit

Permalink
Cleanup README (#52)
Browse files Browse the repository at this point in the history
* Replicate Modrinth page + a little bit

* More

* Little changes
  • Loading branch information
KyGost authored Oct 1, 2021
1 parent e7bd958 commit eafbd86
Showing 1 changed file with 37 additions and 33 deletions.
70 changes: 37 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,58 @@
### Note
This mod is currently in a transition phase. There might be some messes in information and whatnot. Changes incoming!
<h1 align="center">Art of Alchemy</h1>
<p align="center">
<!-- TODO: Mod Banner Here -->
<br />
<a href="https://www.curseforge.com/minecraft/mc-mods/fabric-api"><img title="Requires Fabric API" height="50" src="https://i.imgur.com/Ol1Tcf8.png" /></a>
<br />
<a href="https://discord.gg/G4PjhEf"><img title="Cafeteria Guild Discord" height="60" src="https://discordapp.com/api/guilds/707435077679841350/embed.png?style=banner2" /></a>
</p>

# Art Of Alchemy Memoriam
---

On Friday, August 21st the Fabric community was notified that Amelia Rose, known to us as SynthRose, had tragically passed away. In the wake of that announcement, the community came together in unity and solidarity to remember SynthRose, her work, and her place in our community.
## The World of Alchemy
At the heart of alchemy is the practice of transmutation. The ability to transmute substances into other, more useful substances is a valuable skill for any would-be crafter, and it starts with understanding the world around us. Our world is fundamentally made of two things: materia and essentia.

The goal of this mod is to allow SynthRose's memory to live on in her work, and to posthumously complete and maintain her contributions to the fabric modding community. There are no plans to change the fundamental core principles of the project, but to simply maintain what we believe to be SynthRose's original vision for the project.
Materia is the physical material that all objects are made from. Although in principle all matter is interchangeable, in practice an alchemist will obtain poorer-quality materia from more common items, and richer materia from rare items. Thus, materia comes in seven grades, from F rank through to A and S rank. There are rumors of an eighth "omega" rank, but no concrete evidence of such a thing has ever surfaced.

<p align="center">
<a href="https://www.curseforge.com/minecraft/mc-mods/fabric-api"><img title="Requires Fabric API" height="50" src="https://i.imgur.com/Ol1Tcf8.png"></a>
</p>
Essentia, on the other hand, is the metaphysical essence of an object. You can't interact with it directly; when not bound within an object, it must be dissolved into solution. There are thirteen known types of essentia in this world, named after celestial bodies and related concepts.

<p align="center">Art of Alchemy requires <a href="https://fabricmc.net/use/">Fabric Loader</a> but it does not require Fabric API.</p>
Materia gives essentia substance, and essentia gives materia form. By breaking substances down into these two elements and recombining them in different ways, new substances can be formed.

For more information on Art of Alchemy join the [Cafeteria Guild discord](https://discord.gg/G4PjhEf), or check out the [wiki](https://github.com/Cumulus-Mods/Art-of-Alchemy/wiki)
## Alchemical Machinery
There are three core devices that alchemists make heavy use of in their work.
They are the Calcination Furnace, Dissolution Chamber, and Synthesis Table.

## Mod Requirements & Acknowledgments
To use this mod, you will need:
The Calcination Furnace uses solid fuel (the same sort you'd use in a regular furnace) to burn off the essentia within a substance, leaving behind only materia.

* Minecraft 1.17
* The [Fabric](https://fabricmc.net/) mod loader
* The [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api)
The Dissolution Chamber does the opposite, using alkahest (the universal solvent) to break down the materia of a substance and leave its essentia in solution.

This project uses CottonMC's [LibGUI](https://www.curseforge.com/minecraft/mc-mods/libgui) library. You do not need to install it seperately to play the mod.
Finally, the materia and essentia can be recombined in a Synthesis Table with a small sample of a desired substance to create more of the catalyst substance.

## The World of Alchemy
At the heart of alchemy is the practice of transmutation. The ability to transmute substances into other, more useful substances is a valuable skill for any would-be crafter, and it starts with understanding the world around us. Our world is fundamentally made of two things: materia and essentia.
The basic versions of these machines only extract half of the theoretical yield of a substance; however, a philosopher's stone would allow upgrading these machines to faster and more efficient versions, if you can get your hands one. It also allows for the creation of a Projection Altar to upgrade materia into higher-ranking forms.

Materia is the physical material that all objects are made from. Although in principle all matter is interchangeable, in practice an alchemist will obtain poorer-quality materia from more common items, and richer materia from rare items. Thus, materia comes in seven grades, from F rank through to A and S rank. There are rumors of an eighth "omega" rank, but no concrete evidence of such a thing has ever surfaced.
---

Essentia, on the other hand, is the metaphysical essence of an object. You can't interact with it directly; when not bound within an object, it must be dissolved into solution. There are thirteen known types of essentia in this world, which have been named after the eight planets, plus Apollo (the Sun), Diana (the Moon), the dwarf planets Ceres and Pluto, and the mysterious Void.
## Note
The mod is currently in a transition phase, the wiki is currently down and the repository is a fork.
These things will be fixed soon and numerous additions and fixes are (hopefully) incoming.

Materia gives essentia substance, and essentia gives materia form. By breaking substances down into these two elements and recombining them in different ways, new substances can be formed.
For now the wiki can be found [here](https://github.com/CumulusMC/Art-of-Alchemy/wiki).

## Alchemical Machinery
There are three core devices that alchemists make heavy use of in their work. They are the Calcination Furnace, Dissolution Chamber, and Synthesis Table. The Calcination Furnace uses solid fuel (the same sort you'd use in a regular furnace) to burn off the essentia within a substance, leaving behind only materia. The Dissolution Chamber does the reverse, using alkahest (the universal solvent) to break down the materia of a substance and leave its essentia in solution. Finally, the materia and essentia can be recombined in a Synthesis Table with a small sample of a desired substance to create more of the catalyst substance.

## Questions & Answers
## Acknowledgements
This mod is originally the wonderful work of the late [SynthRose](https://github.com/SynthRose).

**Can you port this mod to Forge?**
We will not be porting this mod to forge, nor will we officially support any ports to the forge modding platform. We maintain and develop this mod in our limited free time. For us it makes more sense to work on adding more feature into the mod than maintaining two versions of it. That being said, this project is licensed under the MIT license meaning if you so desire, you can freely port the mod to forge, but you will not get our official support in any capacity.
Unfortunately Rose is no longer able to contribute to the project but the work lives on.

**Can you update the mod to the latest version?**
In most cases the mod ought to be updated to the latest version, however, if it is not, be assured that we are working hard in order to update as soon as possible. Unfortunately, however, that often takes a little bit of time. Alternatively, if you'd like to contribute towards updating, feel free to make a [pull request](https://github.com/CafeteriaGuild/Art-of-Alchemy/pulls) and we'll be sure look over it.
Originally continued by [CumulusMC](https://github.com/CumulusMC), we have now taken it on.

**I have a cool idea for a feature. Can you add it?**
We make no guarantees about whether or not your idea will make it into the project, however, making a request on the [issues page](https://github.com/CafeteriaGuild/Art-of-Alchemy/issues) is the best way to get our attention. We'll make sure to read through your idea, evaluate whether or not we feel it fits within the scope of the project, and then if we like your idea, we'll add it into the project.
If you feel there is anything you can add to the project please submit it in [the repository](https://github.com/CafeteriaGuild/Art-of-Alchemy) or, get in touch on the [discord](https://discord.gg/G4PjhEf).

**I found a bug. Can you fix it?**
Submit a request on the [issues page](https://github.com/CafeteriaGuild/Art-of-Alchemy/issues) and We'll make sure to take a look at it and do as much as we can in order to fix the issue. It also helps if you provide a crash log, or some more details about what specific behavior is buggy.
### Used Libraries
- [LibGUI](https://www.curseforge.com/minecraft/mc-mods/libgui)
- [Cloth Config](https://github.com/shedaniel/cloth-config)


[![Cafeteria Guild Discord](https://discordapp.com/api/guilds/707435077679841350/embed.png?style=banner2)](https://discord.gg/G4PjhEf)
<p align="center">
<a href="https://discord.gg/G4PjhEf"><img title="Cafeteria Guild Discord" src="https://discordapp.com/api/guilds/707435077679841350/embed.png?style=banner2" /></a>
</p>

0 comments on commit eafbd86

Please sign in to comment.