Skip to content

Commit

Permalink
Prepare opensource (#22)
Browse files Browse the repository at this point in the history
prepare opensource.
  • Loading branch information
axiangcoding authored Jun 30, 2024
1 parent 1163240 commit 9f61628
Show file tree
Hide file tree
Showing 9 changed files with 726 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tagName: ${{ github.ref_name }} # This only works if your workflow triggers on new tags.
releaseName: "wt-helper-app v__VERSION__" # tauri-action replaces \_\_VERSION\_\_ with the app version.
releaseName: "WT-Toolkit v__VERSION__" # tauri-action replaces \_\_VERSION\_\_ with the app version.
releaseBody: "See the assets to download and install this version."
releaseDraft: false
prerelease: ${{ github.event_name == 'push' && contains(github.ref, 'refs/heads/main') && !startsWith(github.ref, 'refs/tags/v') }}
674 changes: 674 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

42 changes: 33 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,40 @@
# Tauri + Vue + TypeScript
# WT-Toolkit | 战雷工具箱

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.
[![Dependabot Updates](https://github.com/axiangcoding/WT-Toolkit/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/axiangcoding/WT-Toolkit/actions/workflows/dependabot/dependabot-updates) [![Lint](https://github.com/axiangcoding/WT-Toolkit/actions/workflows/lint.yml/badge.svg)](https://github.com/axiangcoding/WT-Toolkit/actions/workflows/lint.yml) [![Release](https://github.com/axiangcoding/WT-Toolkit/actions/workflows/release.yml/badge.svg)](https://github.com/axiangcoding/WT-Toolkit/actions/workflows/release.yml)

## Recommended IDE Setup
Select language: English | [简体中文](README.zh-CN.md)

- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
## Introduction

## Type Support For `.vue` Imports in TS
This is a toolkit designed for War Thunder players to provide some useful features to help them manage the game better.

Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
> [!warning]
> This project is still under development, and some features may not work properly. Please report any issues you encounter.
1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
## Features

You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).
We are supporting the following features now:

- [x] User customised skin management
- [x] User customised sight management

And we are planning to support the following features in the future:

- [ ] GUI support for [wt_ext_cli](https://github.com/Warthunder-Open-Source-Foundation/wt_ext_cli)
- [ ] Multi-language support

## Installation

You can install the toolkit by downloading the latest release from the [release page](https://github.com/axiangcoding/WT-Toolkit/releases)

## Usage

**Document is still working in progress.**

## Contributing

**Document is still working in progress.**

## License

This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.
10 changes: 10 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# WT-Toolkit | 战雷工具箱

选择语言: [English](README.md) | [简体中文](README.zh-CN.md)

## 简介

这是一个为《战争雷霆》玩家设计的工具箱,提供一些有用的功能,帮助玩家更好地了解游戏。

> [!warning]
> 该项目仍在开发中,部分功能可能无法正常工作。请报告您遇到的任何问题。
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "wt-helper-app",
"name": "wt-toolkit",
"private": true,
"version": "0.0.0",
"type": "module",
Expand Down
2 changes: 1 addition & 1 deletion src-tauri/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src-tauri/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "wt-helper-app"
name = "wt-toolkit"
version = "0.0.0"
description = "A Tauri App"
authors = ["[email protected]"]
Expand Down
8 changes: 4 additions & 4 deletions src-tauri/tauri.conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"distDir": "../dist"
},
"package": {
"productName": "wt-helper-app",
"productName": "wt-toolkit",
"version": "0.0.5"
},
"tauri": {
Expand Down Expand Up @@ -48,7 +48,7 @@
},
"windows": [
{
"title": "三三的战雷小工具",
"title": "WT-Toolkit | 战雷工具箱",
"width": 1600,
"height": 1000,
"center": true,
Expand All @@ -63,14 +63,14 @@
"wix": {
"language": ["en-US", "zh-CN"]
},
"nsis":{
"nsis": {
"displayLanguageSelector": true,
"languages": ["English", "SimpChinese"]
}
},
"active": true,
"targets": "all",
"identifier": "com.github.axiangcoding.wt-helper-app",
"identifier": "com.github.axiangcoding.wt-toolkit",
"icon": [
"icons/32x32.png",
"icons/128x128.png",
Expand Down
2 changes: 1 addition & 1 deletion src/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ async function jumpToBiliBili() {
</template>

<v-app-bar-title>
三三的战雷小工具
战雷工具箱
<v-chip color="green" variant="flat" rounded>
v{{ appVersion }}
</v-chip>
Expand Down

0 comments on commit 9f61628

Please sign in to comment.