Skip to content

Commit

Permalink
start out readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Wyvest committed Jun 17, 2024
1 parent c771fbb commit a09aa39
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# OneConfigExampleMod
<img align="right" src="src/main/resources/polycrosshair.svg" alt="PolyCrosshair Icon"/>

![Powered by OneConfig](https://polyfrost.org/img/cozy_vector.svg)
![Compact Powered by OneConfig](https://polyfrost.org/img/compact_vector.svg)
![Minimal Powered by OneConfig](https://polyfrost.org/img/cozy-minimal_vector.svg)
![Minimal Compact Powered by OneConfig](https://polyfrost.org/img/compact-minimal_vector.svg)
# PolyCrosshair

Example mod implementing OneConfig.
![Compact Powered by OneConfig](https://polyfrost.org/img/compact_vector.svg) ![Dev Workflow Status](https://img.shields.io/github/v/release/Polyfrost/PolyHitbox.svg?style=for-the-badge&color=1452cc&label=release)

## How to use
A crosshair modification mod

## Features

-

## Gallery

![settings-page.png](images/settings-page.png)

- Copy the template either by using GitHub's "Use this template" feature or downloading the repo manually.
- **Remove the license named "LICENSE-TEMPLATE" and choose a new one.**
- Refactor the template (specifically, the modid, version and name in the gradle.properties and most of the class names)
to a different name.
- Have fun modding! :D
8 changes: 8 additions & 0 deletions src/main/resources/polycrosshair.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a09aa39

Please sign in to comment.