diff --git a/README.md b/README.md new file mode 100644 index 0000000..44c935f --- /dev/null +++ b/README.md @@ -0,0 +1,85 @@ +# CrewTracker +>A great app to help you become a more competitive player in Among Us. + + +[Crew Tracker in Action](https://www.youtube.com/watch?v=6dUTKkhgFaw) + +# Download + + +[Download Crew Tracker](https://github.com/ZynoZin/CrewTracker/releases/tag/v1.0.1) + + +## Feedback/Suggestions + +if you have any feedback or suggestions, make sure to submit them [here](https://docs.google.com/forms/d/e/1FAIpQLSfz_3v6WSWMRyInFx7F5Ta0zSAhwQLUqRtvlVYz2hEpEuzvJw/viewform?usp=sf_link) + + +# How it works: + +## An interactive bar + + + +Clicking on the "-" field will make the rest of the app not visible, then it is changed with a "+" sign, clicking on it will make the rest of the app visible. + +Clicking on the volume button will mute the sound effects and vice versa. + +the bar will always appears on top of your screen, even if you clicked somewhere on an other application. + +the application is draggable from the bar. the "X" is to close the application. + + + + + +## Map Buttons +a set of buttons containing the available maps on Among us which are Skeld, Polus and Mirah. Clicking on one of them will make the corresponding map visible. + + + + + + + + + + +## Write Notes in-game +Found something suspicious? Don't want to forget it before the next meeting? Well now you can edit notes while playing, there is a notes area at the bottom left of the app. + + + + + + + +## Clear Notes +Finished with the previous notes? You can remove them by simply clicking on "Clear Notes". + + + + + + + + +## Draggable Characters +after selecting your map, you can drag whatever character on the map. For example if you saw Brown in Admin room, you can place his character in admin room, so you remember in the next meeting that he was there at some point. + + + + + + + + +## Reset positions +after moving the characters, and you would like to put everything back to place, simply click on "Reset Positions" and it will do the work for you. + + + + + + +