Skip to content

Commit

Permalink
add readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
Afonin-Anthony committed Jul 16, 2024
1 parent 48f7120 commit 0c055a0
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 1 deletion.
13 changes: 13 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# gradle
.gradle/
build/
bin/

# forge
run/
run-data

# eclipse
.settings/
.classpath
.project
22 changes: 22 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License

Copyright (c) 2024 Anthony Afonin

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Introduction
Aim assist is a mod that allows you to automatically aim at enemy.

![](images/img0.png)

## Getting started
This mod requires Minecraft Forge 1.12.2. Download the jar file from the latest release (or build it manually from source) and copy it to you mods directory. Check if the mod is loaded through the Forge mods menu.

Use `/aimassist enable` to enable aim assist and `/aimassist disable` to disable respectively.

If you want to use mods like [MacroKey](https://github.com/Matts/MacroKey) for toggle aim assist state, use `/aimassist toggle`

## License
Aim assist is provided under MIT license. Feel free to explore, make changes and share with friends!

## Contributing
find me gf pls..

2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ mapping_channel=snapshot
mapping_version=20171003-1.12

mod_id=aimassist
mod_name=Aim Assist
mod_name=Aim assist
mod_license=MIT
mod_version=1.0.0

Expand Down
Binary file added images/img0.png
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 0c055a0

Please sign in to comment.