Skip to content

About

A companion app & in-game overlay for PokeMMO, that unifies certain resources & tools about the game in a single place, rather than needing to search for everything all the time.

Resources

Stars

5 stars

Watchers

1 watching

Forks

Latest commit

 

History

54 Commits

Folders and files

Repository files navigation

PokeMMO-Companion

CI & Release Latest Release License GitHub repo size Total Downloads

image

Contents

Installation

  1. Download the latest release from releases section
  2. Extract the application archive to where you typically store your applications (location doesn't matter, aslong the contents of the PokeMMO-Companion folder stay on the same relative path to one another)
  3. Open the PokeMMO-Companion executable (PokeMMO-Companion.exe on Windows, PokeMMO-Companion on Linux)

Note

You must also repeat this process to update to a newer release, since I haven't had the time to make a proper installer.
Just be sure to copy over all custom changes you made to the resources folder.

Warning

The Ubuntu(Linux) release doesn't yet work well as an overlay over PokeMMO. For now disabling the overlay functionality in the settings (Alt + O) and switching between PokeMMO and the companion-app by Alt-tabbing is probably the most convenient way to use the app on ubuntu.
I experimented with some stuff for wayland compositors, but it turns out to be quite clunky right now. To get it somewhat working you could accept the sudo privileges for noticing hotkeys at application start and then manually click on the top application bar -> select "Always on top", since e.g. Gnome DE sadly ignores all automated calls to set the layer. Maximizing the window also negates the "Always on top"-effect, therefore I prohibit it.
But since I mainly play on ubuntu I will have a look into the more relaxed X11 frontend soon, and try to get the overlay functionality working there too. Please open an issue if you also wait for that support, so I know there is a demand for it.

Features

Overlay Functionality

  • switch between 3 modes (Focused, Visible, Closed) with Alt + F(ocused) / V(isible) / C(losed)

    • Focused (Alt + F):

      • clicks & hotkeys interact with the overlay now
      • enables action-bar in the bottom center which can be used to open the feature windows image\
    • Visible (Alt + V):

      • the overlay is not interactable, but still visible on-top of PokeMMO
    • Closed (Alt +C):

      • the overlay is closed/hidden fully
  • overlay can also be disabled entirely, to have it behave like any other opaque window, if you want to put it on a second monitor anyway.


Notes (Atl + N)

  • persistent Notes/ToDo system with simple styling options, so you can easily keep track of your plans and progress

Notes\


Resources (Alt + R)

  • see all resources you need directly in the overlay instead of searching the forums and such everytime again

Resources\

  • easily write your own resources, if you need something else often
    • just add or edit the md-files in the "assets/resources/" folder

    • they support plain text (markdown format: headings, bold text, tables), AppLinks (links to other md-files) and WebLinks (open in browser when clicked)

      image
      WriteCustomResources_Guide\


Type Matrix (Atl + T)

  • open a scrollable Type-Matrix to quickly remind you what's effective against poison types

  • the window can be resized and positioned wherever it suits your screen layout and acts as a helpful reminder in e.g. PVP battles

    image\


Example Usage

Notes & Resources

PokeMMO-Companion_Showcase_Notes_Resources_720p_compressed.mp4

Contributing and Support

For all issues, feature requests or support questions please open a new issue. I am always happy to help.
All pull requests are welcome, but they must be approved by me before being merged.

License

This project is under the standard MIT License.
Do anything you like with it, but keep it free for everyone.

About

A companion app & in-game overlay for PokeMMO, that unifies certain resources & tools about the game in a single place, rather than needing to search for everything all the time.

Resources

Stars

5 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages