Move all examples to the examples directory

discordjs · Jun 23, 2024 · 0089a69 · 0089a69
1 parent 7cb956f
commit 0089a69
Show file tree

Hide file tree

Showing 51 changed files with 15 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ A list of ready-to-run examples for `@discordjs/voice`.
 
 ## How to try them out
 
-All you have to do is copy the example directory of your choosing, install the dependencies, fill in the `.env` file, and run `npm run start`.
+All you have to do is copy an example of your choosing from the [examples](./examples) directory, install the dependencies, fill in the `.env` file, and run `npm run start`.
 
 ## Links
 

diff --git a/_base/.env.example → examples/_base/.env.example b/_base/.env.example → examples/_base/.env.example
diff --git a/_base/.eslintrc.json → examples/_base/.eslintrc.json b/_base/.eslintrc.json → examples/_base/.eslintrc.json
diff --git a/_base/.gitignore → examples/_base/.gitignore b/_base/.gitignore → examples/_base/.gitignore
diff --git a/_base/.prettierignore → examples/_base/.prettierignore b/_base/.prettierignore → examples/_base/.prettierignore
diff --git a/_base/.prettierrc.json → examples/_base/.prettierrc.json b/_base/.prettierrc.json → examples/_base/.prettierrc.json
diff --git a/_base/README.md → examples/_base/README.md b/_base/README.md → examples/_base/README.md
diff --git a/_base/package.json → examples/_base/package.json b/_base/package.json → examples/_base/package.json
@@ -1,7 +1,7 @@
 {
-	"name": "@discordjs/voice-examples-base",
+	"name": "base-bot",
 	"version": "0.0.1",
-	"description": "An example receiver bot written using @discordjs/voice",
+	"description": "A base bot for all examples using @discordjs/voice",
 	"main": "dist/index.js",
 	"type": "module",
 	"scripts": {

diff --git a/_base/src/index.ts → examples/_base/src/index.ts b/_base/src/index.ts → examples/_base/src/index.ts
diff --git a/_base/tsconfig.eslint.json → examples/_base/tsconfig.eslint.json b/_base/tsconfig.eslint.json → examples/_base/tsconfig.eslint.json
diff --git a/_base/tsconfig.json → examples/_base/tsconfig.json b/_base/tsconfig.json → examples/_base/tsconfig.json
diff --git a/basic/.env.example → examples/basic/.env.example b/basic/.env.example → examples/basic/.env.example
diff --git a/basic/.eslintrc.json → examples/basic/.eslintrc.json b/basic/.eslintrc.json → examples/basic/.eslintrc.json
diff --git a/basic/.gitignore → examples/basic/.gitignore b/basic/.gitignore → examples/basic/.gitignore
diff --git a/basic/.prettierignore → examples/basic/.prettierignore b/basic/.prettierignore → examples/basic/.prettierignore
diff --git a/basic/.prettierrc.json → examples/basic/.prettierrc.json b/basic/.prettierrc.json → examples/basic/.prettierrc.json
diff --git a/basic/README.md → examples/basic/README.md b/basic/README.md → examples/basic/README.md
diff --git a/radio-bot/package.json → examples/basic/package.json b/radio-bot/package.json → examples/basic/package.json
@@ -1,7 +1,7 @@
 {
-	"name": "discord-radio-bot",
-	"version": "1.0.0",
-	"description": "A proof-of-concept radio bot for @discordjs/voice",
+	"name": "basic-bot",
+	"version": "0.0.1",
+	"description": "A proof-of-concept basic bot using @discordjs/voice",
 	"main": "dist/index.js",
 	"type": "module",
 	"scripts": {

diff --git a/basic/src/index.ts → examples/basic/src/index.ts b/basic/src/index.ts → examples/basic/src/index.ts
diff --git a/basic/src/util/adapter.ts → examples/basic/src/util/adapter.ts b/basic/src/util/adapter.ts → examples/basic/src/util/adapter.ts
diff --git a/basic/src/util/helpers.ts → examples/basic/src/util/helpers.ts b/basic/src/util/helpers.ts → examples/basic/src/util/helpers.ts
diff --git a/basic/tsconfig.eslint.json → examples/basic/tsconfig.eslint.json b/basic/tsconfig.eslint.json → examples/basic/tsconfig.eslint.json
diff --git a/basic/tsconfig.json → examples/basic/tsconfig.json b/basic/tsconfig.json → examples/basic/tsconfig.json
diff --git a/radio-bot/.env.example → examples/radio-bot/.env.example b/radio-bot/.env.example → examples/radio-bot/.env.example
diff --git a/radio-bot/.eslintrc.json → examples/radio-bot/.eslintrc.json b/radio-bot/.eslintrc.json → examples/radio-bot/.eslintrc.json
diff --git a/radio-bot/.gitignore → examples/radio-bot/.gitignore b/radio-bot/.gitignore → examples/radio-bot/.gitignore
diff --git a/radio-bot/.prettierignore → examples/radio-bot/.prettierignore b/radio-bot/.prettierignore → examples/radio-bot/.prettierignore
diff --git a/radio-bot/.prettierrc.json → examples/radio-bot/.prettierrc.json b/radio-bot/.prettierrc.json → examples/radio-bot/.prettierrc.json
diff --git a/radio-bot/README.md → examples/radio-bot/README.md b/radio-bot/README.md → examples/radio-bot/README.md
diff --git a/basic/package.json → examples/radio-bot/package.json b/basic/package.json → examples/radio-bot/package.json
@@ -1,7 +1,7 @@
 {
-	"name": "basic-voice-bot",
-	"version": "1.0.0",
-	"description": "A proof-of-concept basic voice bot for @discordjs/voice",
+	"name": "radio-bot",
+	"version": "0.0.1",
+	"description": "A proof-of-concept radio bot using @discordjs/voice",
 	"main": "dist/index.js",
 	"type": "module",
 	"scripts": {

diff --git a/radio-bot/src/config.ts → examples/radio-bot/src/config.ts b/radio-bot/src/config.ts → examples/radio-bot/src/config.ts
diff --git a/radio-bot/src/index.ts → examples/radio-bot/src/index.ts b/radio-bot/src/index.ts → examples/radio-bot/src/index.ts
diff --git a/radio-bot/src/util/helpers.ts → examples/radio-bot/src/util/helpers.ts b/radio-bot/src/util/helpers.ts → examples/radio-bot/src/util/helpers.ts
diff --git a/radio-bot/tsconfig.eslint.json → examples/radio-bot/tsconfig.eslint.json b/radio-bot/tsconfig.eslint.json → examples/radio-bot/tsconfig.eslint.json
diff --git a/radio-bot/tsconfig.json → examples/radio-bot/tsconfig.json b/radio-bot/tsconfig.json → examples/radio-bot/tsconfig.json
diff --git a/recorder/.env.example → examples/recorder/.env.example b/recorder/.env.example → examples/recorder/.env.example
diff --git a/recorder/.eslintrc.json → examples/recorder/.eslintrc.json b/recorder/.eslintrc.json → examples/recorder/.eslintrc.json
diff --git a/recorder/.gitignore → examples/recorder/.gitignore b/recorder/.gitignore → examples/recorder/.gitignore
diff --git a/recorder/.prettierignore → examples/recorder/.prettierignore b/recorder/.prettierignore → examples/recorder/.prettierignore
diff --git a/recorder/.prettierrc.json → examples/recorder/.prettierrc.json b/recorder/.prettierrc.json → examples/recorder/.prettierrc.json
diff --git a/recorder/README.md → examples/recorder/README.md b/recorder/README.md → examples/recorder/README.md
diff --git a/recorder/package.json → examples/recorder/package.json b/recorder/package.json → examples/recorder/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "receiver-bot",
 	"version": "0.0.1",
-	"description": "An example receiver bot written using @discordjs/voice",
+	"description": "A proof-of-concept recorder bot using @discordjs/voice",
 	"main": "dist/index.js",
 	"type": "module",
 	"scripts": {

diff --git a/recorder/recordings/.gitkeep → examples/recorder/recordings/.gitkeep b/recorder/recordings/.gitkeep → examples/recorder/recordings/.gitkeep
diff --git a/recorder/src/index.ts → examples/recorder/src/index.ts b/recorder/src/index.ts → examples/recorder/src/index.ts
diff --git a/recorder/src/util/createListeningStream.ts → ...ecorder/src/util/createListeningStream.ts b/recorder/src/util/createListeningStream.ts → ...ecorder/src/util/createListeningStream.ts
diff --git a/recorder/src/util/deploy.ts → examples/recorder/src/util/deploy.ts b/recorder/src/util/deploy.ts → examples/recorder/src/util/deploy.ts
diff --git a/recorder/src/util/interactions.ts → examples/recorder/src/util/interactions.ts b/recorder/src/util/interactions.ts → examples/recorder/src/util/interactions.ts
diff --git a/recorder/tsconfig.eslint.json → examples/recorder/tsconfig.eslint.json b/recorder/tsconfig.eslint.json → examples/recorder/tsconfig.eslint.json
diff --git a/recorder/tsconfig.json → examples/recorder/tsconfig.json b/recorder/tsconfig.json → examples/recorder/tsconfig.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -1,5 +1,2 @@
 packages:
-  - '_base'
-  - 'basic'
-  - 'radio-bot'
-  - 'recorder'
+  - 'examples/*'