Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xen-42 authored Oct 10, 2023
1 parent 42fdb69 commit 1300cb1
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 1300cb1

Please sign in to comment.