Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/flamboyantpenguin/wikilynx

A simple game browser made using Qt C++ for playing wikipedia speedrun the right way
https://github.com/flamboyantpenguin/wikilynx

cpp game qt qt6-gui qtwebengine wikipedia wikipedia-speedrun

Last synced: 2 months ago
JSON representation

A simple game browser made using Qt C++ for playing wikipedia speedrun the right way

Awesome Lists containing this project

README 

        
# wikiLYNX



A simple browser app made using Qt C++ to play wikipedia speedruns the right way. The project was initially made for the wikiLYNX event conducted by [@jonesrison](https://jonesrison.github.io) at Rajagiri School of Engineering and Technology, Ernakulam, Kerala. Documentation is being updated.



## Introduction



### Wikipedia Speed-runs



Wikipedia, one of the world's largest online encyclopedia is sort of a universe of hyperlinks. Deviating from a main article we were supposed to research for our assignment/project, to an article completely different from our initial plans is not an uncommon experience. This experience slowly developed into game of Wikipedia speed-runs. The player will be given an initial Wikipedia article from which one should find another article, perhaps completely unrelated to the initial topic, only through hyperlinks in the page.

This game though not probably recognised by any international organisation, is commonly known to folks among social media as Wikipedia speed-run. The first one to reach, will be the winner!



### wikiLYNX Game Browser



Now a game must have rules! Though the game is not really documented by any Internation Organisation, we have formulated a set of rules we believe is the fundametal aspect of playing the game the right way. Some of these rules can still be disabled in this app, however we apply these rules by default. wikiLYNX Game Browser implements these rules and gives you a game field to play the game with your friends. The app is a simple C++ app based on Qt WebEngine.

If one happens to be someone interested in the game, one is invited to play the game and contribute to the development of this project.



### How to Play



Each level in our game systems consists of a some checkpoints. A checkpoint is basically an article on Wikipedia. Your initial article will be the first checkpoint. You are tasked with navigating to the next checkpoint (next article) through the hyperlinks on the page, The game ends once you reach the final checkpoint. Checkpoints are calculated incrementally, meaning you have to visit them the right order to win (0 -> 1 -> 2) that is, one can't skip checkpoints. The next checkpoint URL will be displayed on the status bar. You can see the current level stats on the View Checkpoints dialog. Each level has a predefined timer. The game ends abrubtly when the timer ends. For competing with your friends, you can use the `Time Taken` field to declare the winner. Time Taken denotes the time taken by the player to finish the level from start till the end. If a player is unable to reach the last checkpoint, the `Time Taken` field denotes the time taken to reach the last checkpoint.



The name you enter in the text field in the welcome dialog is used to register in the leaderboard. The leaderboard can have only 12 names for each level. If you do not enter any name, your name will be registered as `Blondie`. You will know what this means if you have watched a certain Western Cowboy film released in 1966.



By default, you are not allowed to access websites outside Wikipedia from reference links. Doing so will restart the current checkpoint. You're also not allowed to change game window, this will end the game abruptly. These policies can be turned off in settings.



Apart from seeing the Leaderboads, you can see more detailed info about the Game in the directory named `.wLnKMeow`. This is usally seen in the Program Files folder of Windows or in your Home Directory in Linux. We initially developed this software to conduct Wikipedia speed-runs as a competition in our college. So as a measure de security, the game logs all the URLs accessed in a game. Some other details are stored in a file named `report.txt`. You can find all these files in `.wLnKMeow/logs/instanceYYYYMMDDHHMMSS`, denoting the starting time of the game session.



We have included some interesting levels by default. You can add your own levels in the `Edit Level` option in settings. You can also export your levels as a JSON file to share it with your friends. You can download levels from our server using the `Download Level` option or manually from [DAWN Public Archives](https://archive.pcland.co.in/DAWN/Projects/wikiLYNX/levels). To get to know the game, get started with the level `flyingduck`.



## Installation Instructions



The app is available for Windows and Linux.



| Platform                                                                                                                 | Auto Update Support | System Architecture  | OS Version            |

| -------------------------------------------------------------------------------------------------------------------------|------------- | -------------------- | --------------------- |

| [](https://github.com/flamboyantpenguin/wikilynx/wiki/Installation#windows)                   |      ☑️      |  amd64               | Windows 10 and above  |

| [](https://github.com/flamboyantpenguin/wikilynx/wiki/Installation#linux)                   |      ☑️      |  amd64, armhf, arm64 | Debian, RPM, Arch    |



You can find the installation files in [DAWN Archives](https://archive.pcland.co.in/DAWN/Projects/wikiLYNX) or in [GitHub Releases](https://github.com/flamboyantpenguin/wikilynx/releases/latest). To learn more about installation, please refer the [wiki](https://github.com/flamboyantpenguin/wikilynx/wiki/Installation).



## Updates



To update wikiLYNX, you can use the Maintenance Tool in Windows or update packages via your respective package managers for Linux. You can access Maintenance Tool from wikiLYNX start menu folder.



## Development



wikiLYNX is made using Qt6 WebEngine. As of now the source is compatible for Windows and Linux (should be compatible for macOS as well). You can contribute to the project by adding a PR to this repo. Do follow basic contribution guidelines. If you want to contribute to the project but is unsure where to get started, read this [section](https://github.com/flamboyantpenguin/wikilynx/wiki/Development) or contact me at [[email protected]](mailto:[email protected]).



### Getting Started



To compile this project, you need to have the following components installed in your system. 



- Qt6

  - Qt WebEngine

  - Qt Positioning

  - Qt WebChannel

  - Qt Desktop (MSVC)

  - cmake

- git

- gcc/msvc (project not tested in clang; should work)



After this clone this repository and start contributing. You can contact me via email or raise an issue on GitHub if you 

encounter errors during build. For more info please refer the [wiki](https://github.com/flamboyantpenguin/wikilynx/wiki/Development).



### Contribute



Use any IDE like Qt Creator to modify the files. Do note the following before you submit a Pull Request.



- Respect everyone

- Follow exisiting project structure

- Follow contribution guidelines

- Check changes before you commit them

- Avoid adding secrets, build files or user configurations to commits



The source files are in wikiLYNX directory.



- wikiLYNX/header contains the necessary C++ header files

- wikiLYNX/ui contains the Qt UI files

- wikiLYNX/assets contains the assets for the game

- wikiLYNX/debian contains debian packaging info



## Feedback



You can submit your feedback about the project in the discussions page or in this [Google Form](https://forms.gle/SScZKbFLFBffdVay8).



## About



```Txt

wikiLYNX 1.3.0



Last Updated: 06-11-2024

Made by DAWN/ペンギン

```



![DAWN](https://github.com/user-attachments/assets/e634151e-0178-4168-aca4-9664237d7ace)