Skip to content
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Craft This From That
All The Items You Could Have Ever Not Wanted!

[![curseforge](https://img.shields.io/badge/-CurseForge-gray?style=for-the-badge&logo=curseforge&labelColor=orange)](https://www.curseforge.com/minecraft/mc-mods/ctft) [![modrinth](https://img.shields.io/badge/-modrinth-gray?style=for-the-badge&labelColor=green&labelWidth=15&logo=appveyor&logoColor=white)](https://modrinth.com/mod/ctft) [![release](https://img.shields.io/github/v/release/chyzman/ctft?logo=github&style=for-the-badge)](https://github.com/chyzman/ctft/releases) [![discord](https://img.shields.io/discord/857445367388569621?label=The%20Chyz%20Cult&logo=discord&logoColor=white&style=for-the-badge)
23 changes: 23 additions & 0 deletions docs/wiki/Home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# ;TLDR

## Requirements
Requirements are located [here](https://github.com/leabastien/ctft-french/wiki/Usage#requirements)

## RAM
Minimal amount `5120mb`

Minimal amount(playable) `8192mb`

Recommended amount `infinite`



To reduce memory usage disable parts of the mod in the config

(Compressed blocks heavily impacts memorey usage)


## Config
The in-game config can be accesed using **Mod Menu** ([curseforge](https://www.curseforge.com/minecraft/mc-mods/modmenu), [modrinth](https://modrinth.com/mod/modmenu))


48 changes: 48 additions & 0 deletions docs/wiki/Usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Requirements
## Mods
### Required
These mods are required to launch the game

**Fabric API** ([curseforge](https://www.curseforge.com/minecraft/mc-mods/fabric-api), [modrinth](https://modrinth.com/mod/fabric-api))

**owo lib** ([curseforge](https://www.curseforge.com/minecraft/mc-mods/owo-lib), [modrinth](https://modrinth.com/mod/owo-lib))

**ARRP** ([curseforge](https://www.curseforge.com/minecraft/mc-mods/ctft/relations/dependencies), [modrinth](https://modrinth.com/mod/arrp))

**Cloth config** ([curseforge](https://www.curseforge.com/minecraft/mc-mods/cloth-config-legacy), [modrinth](https://modrinth.com/mod/cloth-config))

### Recommended
These mods are technically optional but they make the game actually playable.

**FerriteCore** ([curseforge](https://www.curseforge.com/minecraft/mc-mods/ferritecore-fabric), [modrinth](https://modrinth.com/mod/ferrite-core))

**XL Packets** ([curseforge](https://www.curseforge.com/minecraft/mc-mods/xl-packets-fabric)

### Compatible
These mods are supported

**REI** ([curseforge](https://www.curseforge.com/minecraft/mc-mods/roughly-enough-items), [modrinth](https://modrinth.com/mod/roughly-enough-items))


**PigLib** ([curseforge](https://www.curseforge.com/minecraft/mc-mods/piglib), [modrinth](https://modrinth.com/mod/piglib))


## System
You must allocate at least `5120mb` of memory to minecraft for the mod to launch.

It is recommended to allocate `8192mb` of memory for playability and reduced launch times.

The more you can give it the best it is.


Alternativily you can disable parts of the mod in the configs to reduce memory usage

(Compressed blocks have heavy impact on memory)

# Configuration
## In-Game
The in-game configuration can be accessed using **Mod Menu** ([curseforge](https://www.curseforge.com/minecraft/mc-mods/modmenu), [modrinth](https://modrinth.com/mod/modmenu)).


## Config file
The config file is located in `.minecraft\config\ctft.json5`.