normolo / waldo.desktop.app

WALDO's electron development

WALDO Desktop Application

This is a desktop application for the WALDO cheat detection software.
Explore the docs »

· Report Bug · Request Feature ·

🗃️Table of Contents

1. 📌About
   • 🏗️Built With
2. 📚Getting Started
3. 💖Contributing
4. 📏License
5. 📤Contact
6. 💗Acknowledgments

📌About

A deep learning Artificial Intelligence (A.I.) can detect the human behavioral characteristics of a user within a video game. We plan to train an A.I. to understand how humans play video games via a visual machine learning program. Once the program understands how humans play video games based on gameplay footage, we can then feed it the gameplay footage to determine if the player in the footage is receiving assistance from a 3rd party "hack" or "cheat" program.

(back to top)

🏗️Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• React.js
• electron
• electron-builder
• craco

(back to top)

📚Getting Started

To get started with this project, you will need to read the documentation on how to start contributing to the project.

💖Contributing

To contribute to this project, you will need to read the documentation on how to start contributing to the project. and read the global contributing guidelines.

📐Setup Development Environment

📌Install Dependencies

First you will need to install the dependencies for your project. We recommend using yarn to install all dependencies.

$ yarn install

⚙️Begin Development

There are many was to start development with the electron application, you can either start by running the following command:

$ yarn start
# or 
$ yarn dev

or you can run the following command to start the application in development mode:

$ yarn react:start
$ yarn electron:start

🧪Run Tests

To run test or use format your code, you can run the following command:

$ yarn lint
$ yarn run craco test

You will need to create your own test file to run the tests, unless there is a pre-existing test file. We encourage you to write your own test file to run the tests so that your when you PR your code, you don't need to wait for other developers to run tests on your code.

🏗️Local Building

To build the application for local development, you can run the following command:

$ yarn build:win

This will build the application for windows with two new directories: dist and build. In the build directory, you will find the webpack bundle. You will find the packaged application in the dist directory and the unpackaged application in the dist/win-unpacked directory.

(back to top)

📏License

Distributed under the MPL License. See LICENSE.md for more information.

(back to top)

📤Contact

Twitter: @waldovision

Organisation Link: https://github.com/waldo-vision

(back to top)

💗Acknowledgments

Many thanks to the following projects for the use of their code:

• electron
• electron-builder
• craco
• facebook/react

(back to top)