|
1 |
| -# electron-quick-start |
| 1 | +# evClient |
| 2 | +evClient is an unofficial client for the browser game [ev.io](https://ev.io). The client is not made nor is affliated with the developers of ev.io. By downloading evClient, you promise to adhere to the following rules: |
2 | 3 |
|
3 |
| -**Clone and run for a quick way to see Electron in action.** |
| 4 | +1. You should use the client without the intention of stealing the code or modifying the code in the client without permission from the developers. |
4 | 5 |
|
5 |
| -This is a minimal Electron application based on the [Quick Start Guide](https://electronjs.org/docs/tutorial/quick-start) within the Electron documentation. |
| 6 | +## Client Shortcuts |
6 | 7 |
|
7 |
| -**Use this app along with the [Electron API Demos](https://electronjs.org/#get-started) app for API code examples to help you get started.** |
| 8 | +F1 - Opens a dialog where you can join your friends via an invite link (coming soon) |
8 | 9 |
|
9 |
| -A basic Electron application needs just these files: |
10 | 10 |
|
11 |
| -- `package.json` - Points to the app's main file and lists its details and dependencies. |
12 |
| -- `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**. |
13 |
| -- `index.html` - A web page to render. This is the app's **renderer process**. |
| 11 | +## Installation |
14 | 12 |
|
15 |
| -You can learn more about each of these components within the [Quick Start Guide](https://electronjs.org/docs/tutorial/quick-start). |
| 13 | +### For Windows: |
| 14 | +1. Install [here](https://github.com/PoweredByWard/evClient/releases/tag/1.01) |
| 15 | +2. Open PoweredClient.exe |
16 | 16 |
|
17 |
| -## To Use |
| 17 | +### For Other Platforms: |
| 18 | + #### Linux |
| 19 | + 1. Install [here](https://github.com/PoweredByWard/evClient/releases/tag/L1.01) |
| 20 | + 2. Run PoweredClient |
| 21 | + #### Mac |
| 22 | + Coming soon |
18 | 23 |
|
19 |
| -To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line: |
| 24 | +## Contact |
20 | 25 |
|
21 |
| -```bash |
22 |
| -# Clone this repository |
23 |
| -git clone https://github.com/electron/electron-quick-start |
24 |
| -# Go into the repository |
25 |
| -cd electron-quick-start |
26 |
| -# Install dependencies |
27 |
| -npm install |
28 |
| -# Run the app |
29 |
| -npm start |
30 |
| -``` |
| 26 | +To report issues or enquire about something, you may send me a DM (Powered#3959). |
31 | 27 |
|
32 |
| -Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt. |
| 28 | +## Credits |
33 | 29 |
|
34 |
| -## Resources for Learning Electron |
35 |
| - |
36 |
| -- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation |
37 |
| -- [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - sample starter apps created by the community |
38 |
| -- [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app |
39 |
| -- [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further |
40 |
| -- [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - an Electron app that teaches you how to use Electron |
41 |
| -- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs |
42 |
| - |
43 |
| -## License |
44 |
| - |
45 |
| -[CC0 1.0 (Public Domain)](LICENSE.md) |
| 30 | +Developed in collaboration by PoweredTV |
0 commit comments