Skip to content

Commit

Permalink
[skip ci] README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Poliwrath authored Dec 29, 2019
1 parent 18ff92d commit 85afd4f
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# OpenParrot

REQUIRED FOR THIS PROJECT: https://github.com/teknogods/TeknoParrotUI
Open Source version of TeknoParrot by NTA, avail and Reaver. Works in collaboration with [TeknoParrotUI](https://github.com/teknogods/TeknoParrotUI).

BOUNTIES FOR THIS PROJECT: https://docs.google.com/spreadsheets/d/1gC2vCqWq93Blmg6XsbVYxEsMU3y1p6WPzbnkbtrg_k0/edit?usp=sharing
[TeknoParrot Discord](https://discord.gg/kmWgGDe), development discussion is in the ``#openparrot-dev`` channel.

HOW TO COMPILE (VISUAL STUDIO):
1. Execute premake.bat for vs2017, for older versions: please edit the bat accordingly.
2. Open in Visual Studio via .sln and compile. (x86 or x64)
[Bounties](https://docs.google.com/spreadsheets/d/1gC2vCqWq93Blmg6XsbVYxEsMU3y1p6WPzbnkbtrg_k0/edit?usp=sharing)

How to easiest work on new titles: (For devs) (See STREAM: https://www.twitch.tv/videos/308359681 )
1. Run TeknoParrotUi with command line with some profile that is compatible with your game or create a new XML with according buttons / jvs modes. (TeknoParrotUi.exe --profile=ggxx.xml very good for stick games)
2. Open game executable in x64dbg ( https://x64dbg.com/#start )
3. Write loadlib OpenParrot / loadlib OpenParrot64 in x64dbg command textbox with full directory to OpenParrot. (See STREAM: https://www.twitch.tv/videos/308359681 )
# Compiling (VS 2019)

1. Execute ``premake.bat``, for older versions, please edit the bat accordingly.
2. Open in Visual Studio via .sln and compile. (x86 or x64)

# Adding support for new games

See STREAM: https://www.twitch.tv/videos/308359681

1. Run TeknoParrotUi with command line with some profile that is compatible with your game or create a new GameProfile with according buttons / JVS modes. (``TeknoParrotUi.exe --profile=ggxx.xml`` is very good for stick games)
2. Open game executable in [x64dbg](https://x64dbg.com/#start)
3. Write ``loadlib OpenParrot`` (or ``OpenParrot64``) in x64dbg command textbox with full directory to OpenParrot.
6. The dll should now be loaded and you can work on the game.
7. Remember to add signature of the game to the GameDetect.cpp (Either PE CRC or byte pattern check. Check already existing ones)
7. Remember to add signature of the game to ``GameDetect.cpp`` (Either PE CRC or byte pattern check. Check already existing ones)

0 comments on commit 85afd4f

Please sign in to comment.