Skip to content

Commit 91d1ae5

Browse files
committed
add plugin workspace information to read me, temporarily put the RST file here till the wiki is ready
1 parent 1e3dc43 commit 91d1ae5

File tree

2 files changed

+67
-1
lines changed

2 files changed

+67
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A Minecraft plugin API (not including an implementation). It is licensed under t
99
* [Wiki]
1010
* [Community Chat]: #sponge on irc.esper.net
1111
* [Development Chat]: #spongedev on irc.esper.net
12-
12+
* [Plugin Workspace Info(temporary link)]: https://github.com/SpongePowered/SpongeDocs/blob/master/pluginWorkspace.rst
1313
## Prerequisites
1414
* [Java] 6
1515

pluginWorkspace.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
Setting up your Workspace
2+
=========================
3+
This will be moved to the Sponge wiki
4+
=========================
5+
6+
The Sponge maven repository is at http://repo.spongepowered.org/Sponge/maven/.
7+
All sponge artifacts are under the group ID of ``org.spongepowered``.
8+
9+
Artifact IDs are as follows:
10+
11+
- the API: ``spongeapi``
12+
- the forge based implementation: ``sponge``
13+
14+
Sponge plugins can be compiled with `Gradle <http://gradle.org>`__ or `Maven <http://maven.apache.org>`__.
15+
16+
The Sponge team recommends the use of Gradle as use of the Forge team's ForgeGradle plugin can allow testing of Sponge inside Eclipse or Intellij IDEA development environments.
17+
18+
Development builds use the SNAPSHOT system
19+
20+
Gradle
21+
------
22+
23+
Gradle users place the following in your build.gradle:
24+
25+
.. code-block:: groovy
26+
27+
repositories {
28+
mavenCentral()
29+
maven {
30+
name 'Sponge maven repo'
31+
url 'http://repo.spongepowered.org/Sponge/maven'
32+
}
33+
}
34+
35+
dependencies {
36+
compile "org.spongepowered:spongeapi:1.0.0"
37+
}
38+
39+
Maven
40+
-----
41+
42+
Maven users place the following in your pom.xml:
43+
44+
.. code-block:: xml
45+
46+
<repositories>
47+
<repository>
48+
<id>sponge-maven-repo</id>
49+
<name>Sponge maven repo</name>
50+
<url>http://repo.spongepowered.org/Sponge/maven</url>
51+
<releases>
52+
<enabled>true</enabled>
53+
</releases>
54+
<snapshots>
55+
<enabled>true</enabled>
56+
</snapshots>
57+
</repository>
58+
</repositories>
59+
60+
<dependencies>
61+
<dependency>
62+
<groupId>org.spongepowered</groupId>
63+
<artifactId>spongeapi</artifactId>
64+
<version>1.0.0</version>
65+
</dependency>
66+
</dependencies>

0 commit comments

Comments
 (0)