https://github.com/vadniks/dandybotnative

https://github.com/vadniks/dandybotnative

cmake event-driven game graphics2d programming-game qt-framework qt6 roguelike scripting shared-library ui

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/vadniks/dandybotnative
• Owner: vadniks
• License: other
• Created: 2023-02-07T14:47:14.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-03-19T11:58:44.000Z (almost 2 years ago)
• Last Synced: 2024-10-13T00:42:27.701Z (2 months ago)
• Topics: cmake, event-driven, game, graphics2d, programming-game, qt-framework, qt6, roguelike, scripting, shared-library, ui
• Language: C++
• Homepage:
• Size: 572 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DandyBotNative

This is a QT port of the Peter Sovietov's DandyBot

(https://github.com/true-grue/DandyBot) which was written in 2021-2022.

Ported from Python and Tkinter to the QT framework and C++ by Vad Nik

(https://github.com/vadniks/DandyBotNative) in 2023.

Sublicensed under GNU GPL v2 from MIT.

# Screenshots

![Launch widget](a.png "Launch widget")

![Game process](b.png "Game process")

![Debug TUI support](c.png "Debug TUI support")

# Interaction

User can interact with the game in two ways: manually press keyboard buttons

in order to move the player character or write a `C script` using the provided

header and build script inside the `sharedLib` folder and then build a shared 

library with `CMake`. This library then will be loaded at runtime by the game 

and the script will be executed on each tick.

Entry point of the shared library is the only available function in it - script(...).

It has several useful parameters such as current coordinates and objects around the player.

The function must return one of the predefined action such as move left or right.

Script debugging via TUI is also supported.

### Build

The library itself is compiled by either `GCC` or `Clang` on Linux x86_64 and is built by 

`CMake`. The whole build process can be initialized via the supplied shell script `build.sh`.

After successful execution of the build shell script both executable & shared library can 

can be found at `bin` directory. Use of the `chmod +x build.sh` command might be useful in 

order to grant execution permission to launch the script.

Script parameters and return value is described in detail in the `script.h` header file 

which can be found at `sharedLib` folder.

Programs needed to build the game & the shared library containing a script: 

`clang` or `gcc`, `cmake`, `make` and some text editor. Also, the `QT Framework` 

packages & headers must be presented in user's linux distribution.