From 215e589438e45d5a002cb985b1766545fa85a2f4 Mon Sep 17 00:00:00 2001 From: Riddle <> Date: Sun, 29 May 2022 20:09:12 -0400 Subject: [PATCH] Updated readme for contributions --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 319e58f..b86b2e4 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,20 @@ Open up D2R and wait till you are at the hero selection screen. Make sure the ch You can either run from python. Follow [development.md](development.md) for that. Or you download the a prebuilt release [here](https://github.com/aeon0/botty/releases) (the .rar file!). Start `main.exe` in the botty folder. Focus your D2R window and press the start key (default f11). You can always force stop botty with f12. Note: Botty will use the /nopickup command in the first game to avoid pickup up trash while traversing. This command will only allow item pickup when "show items" is active. +## Development + +Check out the [development.md](development.md) docu for infos on how to build from source and details of the project structure and code. + +## Support this project 💓 + +You can support this project by giving feedback, reporting bugs, or creating pull requests. +Contributions are welcome, and we encourage you to contribute to this project if you would like to help out. Botty is a open source project and almost excessively maintained by contributors (there has been 50+ contributors! <3). In our [**discord**](https://discord.gg/Jf3J8cuXWg) there is a contributor role, and you can ping one of the admins and ask for the role to talk to other contributors! Though you don't need to be in the [**discord**](https://discord.gg/Jf3J8cuXWg) to contribute, we do encourage you to do so. + ## Graphic Debugger To check if you graphic settings are good and if the bot would pick up items there is a **Graphic Debugger Mode**. Start botty and press F10 (Default key). This will open up a (mostly black) window. Start a game in D2R and go to A5. You should see some templates with blue circles detected and scores printed out to the console. To check item finding, throw some items of different types on the ground. The debug window should show the item names with black background. If you throw an item on the ground that should be picked up, it will have a red circle. The console will print out the scores for each item that would be picked up. Scores should be well above 0.9 for these items.
-## Development - -Check out the [development.md](development.md) docu for infos on how to build from source and details of the project structure and code. - ## params.ini All botty configuration files are located in the __config__ folder. To ease the switch to new botty versions, you can also overwrite any of the .ini fields in a **custom.ini** file. When a new version of botty is released you just copy the file to the new version without having to port all your **params.ini** changes to the new version. Example: @@ -210,7 +215,3 @@ order=run_pindle, run_eldritch | pathing_delay_factor | A linear scaling factor, between 1 and 10, applied to pathing delays. | | message_headers | Headers that are sent with each messages | | message_body_template | Message body of the post message sent | - -## Support this project - -Support it by contributing in any technical way, giving feedback, bug reports or submitting PRs.