From 1300cb18fda22f29f0f5c9b7a85793ff9d1723f3 Mon Sep 17 00:00:00 2001 From: Nick Date: Tue, 10 Oct 2023 00:13:36 -0400 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index eb1589a0..4750efb9 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,20 @@ ![Winch](./banner.png) [![Discord](https://img.shields.io/discord/1097191320935735346?style=for-the-badge)](https://discord.gg/qFqPuTUAmD) -[![GitHub issues](https://img.shields.io/github/issues/Hacktix/Winch?style=for-the-badge)](https://github.com/Hacktix/Winch/issues) -[![GitHub all releases](https://img.shields.io/github/downloads/Hacktix/Winch/total?style=for-the-badge)](https://github.com/Hacktix/Winch/releases) +[![GitHub all releases](https://img.shields.io/github/downloads/Hacktix/Winch/total?style=for-the-badge)](https://github.com/DREDGE-Mods/Winch/releases) -**Winch** is intended to be a Mod Loader for the game DREDGE. It is currently heavily under development and there are many improvements to come. As of right now, it's not considered ready for use and there will not be any documentation or instructions until this changes. +Winch is a mod loader for Dredge made by Hacktix. This is a modified version for use with the Dredge mod manager. -## Roadmap +This repo has a few example mods as well: -- [x] Code Execution when booting DREDGE -- [x] Basic Configuration Options for Winch -- [x] Loading separate Mod Assemblies at runtime -- [x] Standardized Mod Format (Metadata JSON File) -- [ ] Provide API to Mod Assemblies to interface with the game -- [ ] Documentation & Examples +### Disaster button + +Press the delete key to trigger a random world event. + +### Example Items + +An example of using Winch to add items to the game, adds a cod and diamonds from Minecraft. + +### Intro Skipper + +Self explanatory. Skips the intro cutscene.