Skip to content

Commit

Permalink
Merge pull request #134 from dalexhd/dev
Browse files Browse the repository at this point in the history
Merge dev into master
  • Loading branch information
dalexhd authored Jun 4, 2020
2 parents 4e19a15 + f1d8e92 commit cab3310
Show file tree
Hide file tree
Showing 86 changed files with 1,121 additions and 3,463 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: [dalexhd]
2 changes: 0 additions & 2 deletions .github/checklist.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,3 @@ paths:
"docs/**":
- "Do you linted the code?"
- "Have you added the new version on metadata.js?"
"packages/server/src/core/Website/api/controllers/auth.ts":
- "Do you replaced findClients() IP variable?"
3 changes: 3 additions & 0 deletions .github/labels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,6 @@
- color: "ffffff"
description: This will not be worked on
name: wontfix
- color: "ce2d2d"
description: Pull requests that update Ruby code
name: ruby
2 changes: 2 additions & 0 deletions .github/semantic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ types:
- perf # Any user observable performance improvement.
scopes:
- new plugin
- new game
- deps
- deps-dev
- img compression
- breaking
- ci
16 changes: 0 additions & 16 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,3 @@ script:
- yarn run test
after_script:
- docker stop teamspeak
jobs:
include:
- stage: deploy
before_install: skip
install: skip
script: skip
after_script: skip
before_deploy:
- yarn run docs:install && yarn run docs:build
deploy:
provider: pages:git
token: ${GH_TOKEN}
name: ${GH_NAME}
email: ${GH_EMAIL}
local_dir: docs/build/
edge: true # opt in to dpl v2
24 changes: 17 additions & 7 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,23 @@
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Iniciar programa",
"skipFiles": [
"<node_internals>/**"
],
"program": "${workspaceFolder}\\packages\\server\\index.js"
//TODO: Fix hot reaload creating multiple instances in DEV environment.
"name": "ts-node-dev",
"type": "node",
"request": "launch",
"protocol": "inspector",
"cwd": "${workspaceRoot}/packages/server",
"runtimeExecutable": "${workspaceRoot}/node_modules/.bin/ts-node-dev",
"args": [
"-r",
"tsconfig-paths/register",
"${workspaceRoot}/packages/server/src/index.ts"
],
"restart": true,
"env": {
"TS_NODE_FILES": "true",
"NODE_ENV": "production"
}
}
]
}
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to SteamSpeak

[SteamSpeak](https://dalexhd.github.io/SteamSpeak/) is a tool that power ups your TeamSpeak3 server. If you're interested in contributing to SteamSpeak, hopefully this document makes the process for contributing clear.
[SteamSpeak](https://steamspeak.netlify.app/) is a tool that power ups your TeamSpeak3 server. If you're interested in contributing to SteamSpeak, hopefully this document makes the process for contributing clear.

The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:

Expand All @@ -12,10 +12,10 @@ The [Open Source Guides](https://opensource.guide/) website has a collection of

There are many ways to contribute to SteamSpeak, and many of them do not involve writing any code. Here's a few ideas to get started:

- Simply start using SteamSpeak. Go through the [Getting Started](https://dalexhd.github.io/SteamSpeak/docs/setup/installation) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues).
- Simply start using SteamSpeak. Go through the [Getting Started](https://steamspeak.netlify.app/docs/setup/installation) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues).
- Look through the [open issues](https://github.com/dalexhd/steamspeak/issues). Provide workarounds, ask for clarification, or suggest labels.
- If you find an issue you would like to fix, [open a pull request](#your-first-pull-request). Issues tagged as [_Good first issue_](https://github.com/dalexhd/steamspeak/labels/Good%20first%20issue) are a good place to get started.
- Read through the [SteamSpeak docs](https://dalexhd.github.io/SteamSpeak/docs/setup/installation). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit" at the end of most docs.
- Read through the [SteamSpeak docs](https://steamspeak.netlify.app/docs/setup/installation). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit" at the end of most docs.
- Take a look at the [features requested](https://github.com/dalexhd/steamspeak/labels/enhancement) by others in the community and consider opening a pull request if you see something you want to work on.

### Join our Discord Channel
Expand All @@ -36,7 +36,7 @@ SteamSpeak has three primary branches: `master`, `dev` and `gh-pages`.

`dev` is where the development takes place.

`gh-pages` contains the [SteamSpeak documentation](https://dalexhd.github.io/SteamSpeak/). This branch is pushed to by Travis CI and not generally managed manually.
`gh-pages` contains the [SteamSpeak documentation](https://steamspeak.netlify.app/). This branch is pushed to by Travis CI and not generally managed manually.

## Bugs

Expand Down
34 changes: 14 additions & 20 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,15 @@ BOLD = $(shell printf "\033[1m")
UP = $(shell printf "\033[5A")

##@ Build
all: ## Build all files
all: ## Build all files.
@make ts

##@ Help
help: ## View all available commands.
$(shell $(TARGETS_EXE))
@echo ${CYAN} Repository: ${UND}${BOLD}$(OUTPUT)${CYAN}${X}${CYAN}${UND} Author: $(AUTHOR)${X}
@echo ${CYAN} Last commit:${X}
@echo ${CYAN} Repository: ${UND}${BOLD}$(OUTPUT)${CYAN}${X}${CYAN} Author: $(AUTHOR)${X}
@echo
@echo ${CYAN} ${UND}Last commit data${X}
@echo ${CYAN} Date: $(LAST_COMMIT_DATE)
@echo ${CYAN} Hash: $(LAST_COMMIT_HASH)${X}
@echo ${CYAN} Message: $(LAST_COMMIT_MESSAGE)${X}
Expand All @@ -82,36 +83,30 @@ TOKEN_SCRIPT = \

##@ Misc

config: ## Create config files
config: ## Create config files.
@if [ ! -d "packages/server/src/config/old.config" ]; then mkdir packages/server/src/config/old.config; fi
@find packages/server/src/config -maxdepth 1 -iname \*.ts -not -iname \*.sawmple.ts -type f -exec bash -c 'for f; do cp "$$f" "packages/server/src/config/old.config/$$(basename $$f)"; done' sh {} +
@echo ${B}Created a restore point inside the ${W}packages/server/src/config/old.config ${B}folder.${X}
@find packages/server/src/config -maxdepth 1 -iname \*.sample.ts -type f -exec bash -c 'for f; do cp "$$f" "$${f/.sample}"; done' sh {} +
@echo

check-ts:
@scripts/check-ts.sh

check-config:
check-config: ## Check if SteamSpeak has been configured and also if there's any missing library.
@scripts/check-config.sh

plugin-tsconfig:
@scripts/plugin-tsconfig.sh


re: ## Call clean => all
re: ## Call clean => all.
@make clean
@make all

##@ Development
release: ## Release a new SteamSpeak version
release: ## Release a new SteamSpeak version.
@make release-prepare
@make generate CHECK_URLS=false

ts: ## Run docker image
ts: ## Run docker image.
@echo ${B}Running: ${R}$(OUTPUT)${X}
@echo
$(DOCKER) run -d --name=teamspeak -p 9987:9987/udp -p 10011:10011/tcp -p 10022:10022/tcp -p 30033:30033/tcp -e TS3SERVER_LICENSE=accept -e TS3SERVER_QUERY_PROTOCOLS=raw,ssh -e TS3SERVER_IP_WHITELIST=whitelist.txt -e TS3SERVER_LOG_QUERY_COMMANDS=1 teamspeak ts3server serveradmin_password=SteamSpeak -v /docker/TeamSpeak/query_ip_whitelist.txt:/var/ts3server/whitelist.txt
$(DOCKER) run -d --name=teamspeak -p 9987:9987/udp -p 10011:10011/tcp -p 10022:10022/tcp -p 30033:30033/tcp -e TS3SERVER_LICENSE=accept -e TS3SERVER_QUERY_PROTOCOLS=raw,ssh -e TS3SERVER_LOG_QUERY_COMMANDS=1 teamspeak ts3server serveradmin_password=SteamSpeak
$(DOCKER) logs teamspeak 2>&1 | grep login | awk '{split($$0, i, ", "); print i[1]}' | tr -d '\t\r\" ' | cut -d "=" -f 2 | xargs -I {} echo "${B}Username: ${W}${BOLD}"{}${X}
$(DOCKER) logs teamspeak 2>&1 | grep login | awk '{split($$0, i, ", "); print i[2]}' | tr -d '\t\r\" ' | cut -d "=" -f 2 | xargs -I {} echo "${B}Password: ${W}${BOLD}"{}${X}
@echo
Expand All @@ -120,21 +115,20 @@ ts: ## Run docker image
@echo ${B}IP: ${G}${BOLD}$(IP)${X}
@echo

clean: ## Clean docker image
clean: ## Clean docker image.
@echo ${B}Stoping container...${X}
$(DOCKER) stop teamspeak > /dev/null 2>&1
$(DOCKER) rm teamspeak -f > /dev/null 2>&1
@echo ${B}Stoping container...${X}

##@ Releasing
release-prepare: ## Prepares the release with metadata and highlights
release-prepare: ## Prepares the release with metadata and highlights.
@scripts/run.sh checker scripts/release-prepare.rb

check-generate: ## Checks for pending `make generate` changes
check-generate: ## Checks for pending `make generate` changes.
@scripts/run.sh checker scripts/check-generate.sh

export CHECK_URLS ?= true
generate: ## Generates files across the repo using the data in /.meta
generate: ## Generates files across the repo using the data in /.meta.
@scripts/run.sh checker scripts/generate.rb

.PHONY: all build clean re
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">

[![Logo](https://i.imgur.com/60jQUwY.gif)](https://dalexhd.github.io/SteamSpeak/)
[![Logo](https://i.imgur.com/60jQUwY.gif)](https://steamspeak.netlify.app/)

## Steam and TeamSpeak integration, done right!

Expand All @@ -21,7 +21,7 @@
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/dalexhd/steamspeak?label=Code%20size&maxAge=3600)](https://github.com/dalexhd/SteamSpeak)


[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://dalexhd.github.io/SteamSpeak)
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://steamspeak.netlify.app)
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/dalexhd/steamspeak)

</div>
Expand All @@ -34,7 +34,7 @@ SteamSpeak is a Node.js and VueJS application which allows you to power up your

<div align="center">

[![Logo](https://raw.githubusercontent.com/dalexhd/resources/master/demo.gif)](https://dalexhd.github.io/SteamSpeak/)
[![Logo](https://raw.githubusercontent.com/dalexhd/resources/master/demo.gif)](https://steamspeak.netlify.app/)

</div>

Expand All @@ -44,7 +44,7 @@ SteamSpeak is a Node.js and VueJS application which allows you to power up your

## Install and Upgrade Guide

For system requirements, installation/upgrade guides, troubleshooting etc., head over to the [Official Documentation](https://dalexhd.github.io/SteamSpeak/).
For system requirements, installation/upgrade guides, troubleshooting etc., head over to the [Official Documentation](https://steamspeak.netlify.app/).

## Caution
**SteamSpeak is currently in development stage**. We recommend you to wait until the v1.0.0 gets released.
3 changes: 0 additions & 3 deletions docker/TeamSpeak/query_ip_whitelist.txt

This file was deleted.

8 changes: 4 additions & 4 deletions docs/docs/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: contributing
title: Contributing to SteamSpeak
---

[SteamSpeak](https://dalexhd.github.io/SteamSpeak/) is a tool that power ups your TeamSpeak3 server. If you're interested in contributing to SteamSpeak, hopefully this document makes the process for contributing clear.
[SteamSpeak](https://steamspeak.netlify.app/) is a tool that power ups your TeamSpeak3 server. If you're interested in contributing to SteamSpeak, hopefully this document makes the process for contributing clear.

The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:

Expand All @@ -14,10 +14,10 @@ The [Open Source Guides](https://opensource.guide/) website has a collection of

There are many ways to contribute to SteamSpeak, and many of them do not involve writing any code. Here's a few ideas to get started:

- Simply start using SteamSpeak. Go through the [Getting Started](https://dalexhd.github.io/SteamSpeak/docs/setup/installation) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues).
- Simply start using SteamSpeak. Go through the [Getting Started](https://steamspeak.netlify.app/docs/setup/installation) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues).
- Look through the [open issues](https://github.com/dalexhd/steamspeak/issues). Provide workarounds, ask for clarification, or suggest labels.
- If you find an issue you would like to fix, [open a pull request](#your-first-pull-request). Issues tagged as [_Good first issue_](https://github.com/dalexhd/steamspeak/labels/Good%20first%20issue) are a good place to get started.
- Read through the [SteamSpeak docs](https://dalexhd.github.io/SteamSpeak/docs/setup/installation). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit" at the end of most docs.
- Read through the [SteamSpeak docs](https://steamspeak.netlify.app/docs/setup/installation). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit" at the end of most docs.
- Take a look at the [features requested](https://github.com/dalexhd/steamspeak/labels/enhancement) by others in the community and consider opening a pull request if you see something you want to work on.

### Join our Discord Channel
Expand All @@ -38,7 +38,7 @@ SteamSpeak has three primary branches: `master`, `dev` and `gh-pages`.

`dev` is where the development takes place.

`gh-pages` contains the [SteamSpeak documentation](https://dalexhd.github.io/SteamSpeak/). This branch is pushed to by Travis CI and not generally managed manually.
`gh-pages` contains the [SteamSpeak documentation](https://steamspeak.netlify.app/). This branch is pushed to by Travis CI and not generally managed manually.

## Bugs

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guide/preparing-for-production.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';

<Alert type="info" closable="true">

**Be sure** that you've configured your [bot](/SteamSpeak/docs/setup/configuration/bot) correctly before running the following command.
**Be sure** that you've configured your [bot](/docs/setup/configuration/bot) correctly before running the following command.

</Alert>

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guide/running-steamspeak.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ import CodeBlock from '@theme/CodeBlock';

<Alert type="info" closable="true">

**Be sure** that you built [SteamSpeak](/SteamSpeak/docs/guide/preparing-for-production) application correctly before running the following command.
**Be sure** that you built [SteamSpeak](/docs/guide/preparing-for-production) application correctly before running the following command.

</Alert>

<CodeBlock className="language-bash" path="~/SteamSpeak">
yarn run start:backend
yarn run start:server
</CodeBlock>
8 changes: 4 additions & 4 deletions docs/docs/reference/plugins/afk-kick.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,24 @@ export const info: CommonPluginConfig = {
name: 'AFK kick',
description: 'This plugin allows you to automatically kick afk people after x time.',
config: {
enabled: true,
enabled: false,
data: {
ignoredGroups: [],
ignoredChannels: [],
interval: {
weeks: 0,
days: 0,
hours: 0,
minutes: 0,
seconds: 5
minutes: 30,
seconds: 0
}
},
interval: {
weeks: 0,
days: 0,
hours: 0,
minutes: 0,
seconds: 5
seconds: 10
}
}
};
Expand Down
9 changes: 4 additions & 5 deletions docs/docs/reference/plugins/afk-move.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,23 @@ export const info: CommonPluginConfig = {
description:
'This plugin allows you to automatically move afk people after x time to your desired channel.',
config: {
enabled: true,
enabled: false,
data: {
goBack: true,
dest: 2,
minTime: {
weeks: 0,
days: 0,
hours: 0,
minutes: 0,
seconds: 5
minutes: 20,
seconds: 0
}
},
interval: {
weeks: 0,
days: 0,
hours: 0,
minutes: 0,
seconds: 5
seconds: 10
}
}
};
Expand Down
19 changes: 10 additions & 9 deletions docs/docs/reference/plugins/change-channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,35 @@ export const info: UncommonPluginConfig = {
name: 'Change channel',
description: 'This plugin allows you to change multiple channels name at different interval.',
config: {
enabled: true,
enabled: false,
data: [
{
enabled: true,
enabled: false,
channelId: 118,
changes: [
{
channel_name: '[cspacer]Welcome',
channel_description: 'Welcome'
channelName: '[cspacer]Welcome',
channelDescription: 'Welcome'
},
{
channel_name: '[cspacer]to',
channel_description: 'to'
channelName: '[cspacer]to',
channelDescription: 'to'
},
{
channel_name: '[cspacer]SteamSpeak',
channel_description: 'SteamSpeak'
channelName: '[cspacer]SteamSpeak',
channelDescription: 'SteamSpeak'
}
],
interval: {
weeks: 0,
days: 0,
hours: 0,
minutes: 0,
seconds: 3
seconds: 5
}
}
]
}
};

```
2 changes: 1 addition & 1 deletion docs/docs/reference/plugins/host-message.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export const info: CommonPluginConfig = {
description:
'This plugin allows you to change default host message with useful server information.',
config: {
enabled: true,
enabled: false,
data: {
showQueryClients: false,
hostMessage: `
Expand Down
Loading

0 comments on commit cab3310

Please sign in to comment.