Skip to content

Commit 744a8ab

Browse files
committed
prepare mvp
Lots of changes to prepare the repo for release.
1 parent e9d5879 commit 744a8ab

24 files changed

+2119
-196
lines changed

LICENSE.md

Lines changed: 124 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
1-
# Vue 3 + TypeScript + Vite
1+
# Beyond All Reason ([BAR](https://www.beyondallreason.info/)) Hotkey Trainer
2+
This is something I threw together for myself when learning the game for the first time. It generated some interest in the community so I've polished it up a bit and am releasing it as open-source and a free tool for others to use, and hopefully grow.
23

3-
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
4+
[BAR Official Website](https://www.beyondallreason.info/)
45

5-
Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
6+
## Stack
7+
- Pinia: vue redux-esc state management https://pinia.vuejs.org/
8+
- Vue3 https://vuejs.org
9+
- Typescript
10+
- Vite
611

7-
## Set Up
12+
## Plans
13+
- [ ] Listen for other key presses like "shift" to clear last pressed key, "esc" to reset the state, something to toggle hotkeys on off
14+
- [ ] Complete entries in `data/objects.yml` (would be nice to parse this from the main repo)
15+
- [ ] Add more tools like price comparisons, etc etc
16+
- [ ] ...
17+
18+
## Contributing
19+
Fork the repo and do your development on your fork. When your changes are ready, make a PR into the `main` branch and request my review.
20+
21+
### Set Up
822
You'll need Node, I'm running 18.20, anything 18 and up should be fine.
923

1024
```
@@ -13,7 +27,7 @@ npm i
1327
npm run dev
1428
```
1529

30+
## Image Attribution
31+
Images are not my own. Images were gathered from the BAR Website. For instance https://www.beyondallreason.info/units/armada-factories
1632

17-
## Contributing
18-
Fork the repo and do your development on your fork. When your changes are ready, make a PR into the `main` branch and request my review.
19-
33+
Images © Beyond All Reason under CC BY-NC-ND 4.0, see [BAR License](https://github.com/beyond-all-reason/Beyond-All-Reason/blob/master/LICENSE.md)

index.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
<!doctype html>
1+
<!DOCTYPE html>
22
<html lang="en">
33
<head>
44
<meta charset="UTF-8" />
55
<link rel="icon" type="image/svg+xml" href="/barhkthicc.png" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<link rel="preconnect" href="https://fonts.googleapis.com" />
8+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
9+
<link
10+
href="https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap"
11+
rel="stylesheet"
12+
/>
713
<title>Hotkey Trainer</title>
814
</head>
915
<body>

0 commit comments

Comments
 (0)