Skip to content

Commit

Permalink
✨ Adding back README.md, LICENSE and .gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
ZorgBtw committed Nov 11, 2023
1 parent 664a7ea commit d723f21
Show file tree
Hide file tree
Showing 3 changed files with 248 additions and 34 deletions.
232 changes: 198 additions & 34 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,42 +1,206 @@
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/

### IntelliJ IDEA ###
.idea/modules.xml
.idea/jarRepositories.xml
.idea/compiler.xml
.idea/libraries/
# Created by .ignore support plugin (hsz.mobi)
### JetBrains template
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf

# Generated files
.idea/**/contentModel.xml

# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml

# Gradle
.idea/**/gradle.xml
.idea/**/libraries

# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated, and may cause churn. Uncomment if using
# auto-import.
# .idea/artifacts
# .idea/compiler.xml
# .idea/jarRepositories.xml
# .idea/modules.xml
# .idea/*.iml
# .idea/modules
# *.iml
# *.ipr

# CMake
cmake-build-*/

# Mongo Explorer plugin
.idea/**/mongoSettings.xml

# File-based project format
*.iws
*.iml
*.ipr

# IntelliJ
out/
!**/src/main/**/out/
!**/src/test/**/out/

### Eclipse ###
.apt_generated
.classpath
# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Cursive Clojure plugin
.idea/replstate.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Editor-based Rest Client
.idea/httpRequests

# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser

### Java template
# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*

### Eclipse template
.metadata
bin/
tmp/
*.tmp
*.bak
*.swp
*~.nib
local.properties
.settings/
.loadpath
.recommenders

# External tool builders
.externalToolBuilders/

# Locally stored "Eclipse launch configurations"
*.launch

# PyDev specific (Python IDE for Eclipse)
*.pydevproject

# CDT-specific (C/C++ Development Tooling)
.cproject

# CDT- autotools
.autotools

# Java annotation processor (APT)
.factorypath
.project
.settings

# PDT-specific (PHP Development Tools)
.buildpath

# sbteclipse plugin
.target

# Tern plugin
.tern-project

# TeXlipse plugin
.texlipse

# STS (Spring Tool Suite)
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/

### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
# Code Recommenders
.recommenders/

# Annotation Processing
.apt_generated/
.apt_generated_test/

### VS Code ###
.vscode/
# Scala IDE specific (Scala & Java development for Eclipse)
.cache-main
.scala_dependencies
.worksheet

# Uncomment this line if you wish to ignore the project description file.
# Typically, this file would be tracked if it contains build/dependency configurations:
#.project

### Gradle template
.gradle
**/build/
!src/**/build/

# Ignore Gradle GUI config
gradle-app.setting

# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
!gradle-wrapper.jar

# Cache of project
.gradletasknamecache

# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
# gradle/wrapper/gradle-wrapper.properties

### NetBeans template
**/nbproject/private/
**/nbproject/Makefile-*.mk
**/nbproject/Package-*.bash
build/
nbbuild/
dist/
nbdist/
.nb-gradle/

### Example user template template
### Example user template

# IntelliJ project files
.idea
*.iml
out
gen
### VisualStudioCode template
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace

### Mac OS ###
.DS_Store
# Local History for Visual Studio Code
.history/
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Zorg

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<h2 align="center">BungeeSK</h2>
BungeeSK is a Skript addon that allows you to communicate with a bungeecord proxy easily !

<br>

## 📥 How to download and install ?
You can download the last available version of BungeeSK by clicking [here](https://github.com/ZorgBtw/BungeeSK/releases/latest).
Then you can drop your `BungeeSK.jar` file in your Bungeecord `plugins/` folder and in every Spigot `plugins/` folder too. Make sure you got Skript running on your Spigot servers. (If not, you can download Skript [here](https://github.com/SkriptLang/Skript/releases/latest))

## 🚀 How to run correctly BungeeSK ?
First, you will need to connect your Spigot servers (called as clients) to your Bungeecord proxy (call as server).
Here's an example of code to link everything:
```applescript
on server start:
while client is not connected: # Using a while loop to try to connect if the client is not connected
create new bungee connection: # Creation of a new Bungeecord connection
set address of connection to "127.0.0.1" # Use this IP if the Bungeecord is on the same machine
set port of connection to 20000 # This port as to be opened if the specified client is not hosted on the same machine as the server
set password of connection to "Strong password" # Complete your password here, this has to be the same as the one in the Bungeecord config
start new connection with last created connection # Sending connection request to the server
wait 30 seconds # Waiting 30 seconds between 2 connection tries, it's recommended to not decrease this value
```

## 📚 Need support or be informed ?
- [**Discord server**](https://discord.gg/PCnyMDsTRA)
- [**Wiki**](https://bungeesk.zorgdev.fr)
- Documentations:<br>
<a href="http://skripthub.net/docs/?addon=BungeeSK" target="_blank"> <img src="http://skripthub.net/static/addon/ViewTheDocsButton.png" height="75"></img></a>
<a href="https://docs.skunity.com/syntax/search/addon:bungeesk" target="_blank"> <img src="https://skunity.com/branding/buttons/get_on_docs_3.png" height="75"></img></a>

0 comments on commit d723f21

Please sign in to comment.