full card structure in place, card binder working.
Some checks failed
Build / build (push) Has been cancelled
Some checks failed
Build / build (push) Has been cancelled
This commit is contained in:
74
README.md
74
README.md
@@ -1,25 +1,61 @@
|
||||
# Mine Triad
|
||||
|
||||
Installation information
|
||||
=======
|
||||
Mine Triad is a NeoForge mod for Minecraft 1.21.1 that brings a Minecraft-themed take on Triple Triad into the game. Collect custom cards, organize them in a binder, and challenge a built-in training opponent on a physical duel table placed in the world.
|
||||
|
||||
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 provided by [GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
|
||||
This project is currently focused on delivering a polished core card game experience: high-quality card presentation, a full starter card pool, an in-world board, and a clean collection UI.
|
||||
|
||||
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.
|
||||
## Features
|
||||
|
||||
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.
|
||||
- 110 unique Triad cards across 10 progression levels
|
||||
- Minecraft-themed card roster with custom names, art, rarity tiers, and stat layouts
|
||||
- In-world `Duel Table` block with a playable 3x3 Triple Triad-style board
|
||||
- Solo duels against a built-in `Training Duelist`
|
||||
- Custom first-person and item rendering for cards
|
||||
- `Card Binder` UI for organizing and previewing your collection by level
|
||||
- JEI integration so every card variant can be browsed directly in item lookup
|
||||
- Separate creative tabs for cards and gameplay items
|
||||
|
||||
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. 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
|
||||
## What Is Implemented Right Now
|
||||
|
||||
Additional Resources:
|
||||
==========
|
||||
Community Documentation: https://docs.neoforged.net/
|
||||
NeoForged Discord: https://discord.neoforged.net/
|
||||
Mine Triad already includes a complete playable duel loop:
|
||||
|
||||
1. Put at least 5 Triad Cards in your inventory.
|
||||
2. Place a Duel Table.
|
||||
3. Right-click the top face of the table to start a duel.
|
||||
4. Hold one of your duel cards and click an open board space to play your turn.
|
||||
5. Alternate turns with the Training Duelist until the board is full.
|
||||
6. Right-click the table again after the result screen to finish the match and return cards.
|
||||
|
||||
The current AI opponent evaluates legal moves and prefers plays that capture the most cards.
|
||||
|
||||
## Card Set Overview
|
||||
|
||||
- `Levels 1-3`: common, lower-power wildlife and passive mob inspired cards
|
||||
- `Levels 4-5`: uncommon hostile mob focused cards
|
||||
- `Levels 6-7`: rare advanced and elite encounter cards
|
||||
- `Levels 8-10`: legendary endgame, structure, item, and community-inspired cards
|
||||
|
||||
The stat layouts are intentionally modeled after the progression curve of classic Triple Triad, but the card identities are reimagined around Minecraft.
|
||||
|
||||
## Items And Blocks
|
||||
|
||||
### Triad Card
|
||||
|
||||
The core collectible item. Each stack stores its own card identity as item data, renders as an individual card, and shows its level, sides, and rarity in the tooltip.
|
||||
|
||||
### Duel Table
|
||||
|
||||
The main gameplay block used to play matches in-world. The board state is shown directly on the table during a duel, and the block prevents normal survival breaking while a match is active.
|
||||
|
||||
### Card Binder
|
||||
|
||||
A collection binder with 110 slots arranged by card level. It supports:
|
||||
|
||||
- per-level paging
|
||||
- persistent storage inside the binder item
|
||||
- previewing the selected card in the UI
|
||||
- locked held-slot behavior so the binder cannot be moved out from under the menu
|
||||
|
||||
### Deck Box
|
||||
|
||||
The item is present in the current build as part of the gameplay set, but deck management behavior is not implemented yet.
|
||||
Reference in New Issue
Block a user