The OutN Project

current release : v8 stable

An actively developed Self-hostable FOSS pokemon recognition and assistant bot for discord and made more specifically for the discord pokemon game "Poketwo".

It can identify Pokémon from Pokétwo spawns, ping a role for rare and regional spawns and pin them, other many features!and it is fully automated and updated.

Made with ❤️ in Python

Skip to Usage/installation

Table of Contents

• The OutN Project
  • Features
  • Roadmap
  • Usage/installation
    • automatic
    • manual
  • Changelog
  • FAQ
  • Feedback and Support
  • Contributing
  • Code Of Conduct
  • License
    • In this case
  • Star History
  • Authors

Features

• ⭐ can be used to make CUSTOM bots for your server
• ⭐ completely FOSS i.e. Free and Open Source
• ⭐ 'Ai' recognition
• ⭐ built-in Starboard
• Rare and regional ping
• catch logging
• built-in hint solver
• both automatic & manual identification support
• spawn logging
• Pretty embeds
• Self-hostable
• fully customizable
• config based - no coding skills required
• easy to use/Beginner-Friendly
• ezy catch - just copy and paste
• Automatic
• Light and not system heavy
• Cross platform

Roadmap

• [x] Ai identification <- v1.0
• [x] Rare ping <- v2.0
  • [x] mythic
  • [x] legendary
  • [x] ultra beast
  • [x] regional
• [x] Embeds <- v3.0
• [x] Hint solver <- v4.0
• [x] StarBoard <- v5.0
• [x] catch logs <- v6.0
• [x] spawn logs <- v7.0
• [x] commands <- v8.0
  • [x] help command
  • [x] identify command
• [ ] more..

Usage/installation

download the OutN bot by

• latest stable release
• source code

1. make a discord bot - guide / official page
2. star this repo 😉 ~~plz~~
3. follow any of the below methods for usage

automatic

extract the folder just run 'run.bat'

it will install dependencies and run the program by itself

for further usage i.e. not the first run and the dependencies are all already installed

you can just run 'just_run.bat' which will only run main.py and nothing else

manual

• requires
  • python to be installed

extract the folder and open a command prompt window in it

1. install dependencies using:

pip install aiohttp discord numpy pillow tensorflow configparser

2. then run the program using:

python main.py

the program will ask for your bot token, role ids (for rare and regional ping) and channel id (for starboard, catch and spawn logger) on initialisation and then will save it to 'config.ini' so that it does not ask you every time it runs.

[!NOTE] the token is only saved locally and is not sent anywhere.

[!CAUTION] make sure not to upload 'config.ini' anywhere as it contains your bot token.

Changelog

CHANGELOG.md

FAQ

Q) I got this error ModuleNotFoundError: No module named '<module name>' what do i do?

A) do pip install <modulename>

rest -> you tell me 😆

Feedback and Support

All and every kind of feedback is welocome. And any constructive criticism is appreciated.

If you have any kind of feedback or need help feel free to contact me:

• Discord
  • @mr.linear
  • OutN support [in development]

Contributing

Contributions are always welcome!

currently you can:

• contribute by fixing any bugs in the code you find
• suggesting features

Code Of Conduct

Please Adhere to the Code of Conduct

License

No License

In this case

• you are free to use and share the software as long as you give credit to the developer a.k.a myself which is only fair.
• you have no permission from the creator of the software to modify, or share the software without credits or without permission. Although a code host such as GitHub may allow you to view and fork the code, this does not imply that you are permitted to modify, or share the software for any purpose or without permission.

Star History

<a href="https://star-history.com/#Pranjal-SB/OutN&Date"><picture><source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Pranjal-SB/OutN&type=Date&theme=dark" /><source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Pranjal-SB/OutN&type=Date" /><img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Pranjal-SB/OutN&type=Date" /></picture></a>

Authors

• Myself