-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
163 lines (129 loc) · 6.83 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
Pokémon Orange and Blue
-----------------------
Created by The Elite Four: Jason Corriveau, Eric Marshall, Ben Matase,
Alexander Murph
Started: April, 2016
Readme.md last updated: 5/2/16
DESCRIPTION
-----------
This is our final project for Software Engineering and Design (CSCI205). A new
take on Pokémon, set at Bucknell University. We aimed to mimic the look and
feel of a real Pokémon game, particularly the 3rd generation games (Ruby,
Sapphire, Emerald, Fire Red, and Leaf Green). We put guest appearances by
Bucknell University professors as gym leaders with their permission. As of
updating this readme, we have gotten the battling in working order. The
user can choose a team of Pokémon from the first four generations with any
moves that the Pokémon could learn in the game. The player can choose to
battle either a random trainer or the next professor or Elite Four member.
The Elite Four consists of the four creators of the game. The game right now
focuses on the battle sequence and has a lot of the functionality that the
real games have. Only physical moves are included and only the damage of
the moves counts (no extra functions of all moves are accounted for).
The player can choose their team in the beginning of the game after
getting past the splash screen. The user can click on any of the 6 buttons
and a panel will appear where there is a drop down list of all choosable
Pokémon. Once a Pokmeon is chosen, the moves part appears and the user
can choose up to four moves for that Pokémon. If everything is valid and
the user clicks the done button, that Pokémon is populated into the button
that the user clicked originally. The user can also click the random
button to randomly populate all 6 Pokémon slots. The user can click done
when they are finished editing their Pokémon team.
At the menu screen, the user can choose to battle a random trainer who
has 6 random Pokémon with 4 random moves, the next professor/Elite Four
member, or to reset their game and choose new Pokémon. The professors are
given an order from first to eighth. You can only advance to the next
professor by beating the current one. When you beat Professor King, you
start to battle the Elite Four, which is the four creators of this game.
Created using the Scrum methodology.
A battle in Pokémon happens as such. There are two Pokémon trainers in
every battle. There is one trainer who is the player of the game and one
trainer who is the NPC (Non-Player Character). Each player has their image
show on the screen and then the NPC says some dialog to the player. They
both send out their first Pokémon. The trainers simultaneously choose a
move for their Pokémon to use or whether they will switch out their current
Pokémon for one in their bag. Once both have chosen, calculations based on
each Pokémon's speed occur to determine which Pokémon will attack first.
Then the faster Pokémon performs their attack and the defending Pokémon loses
HP (Hit Points) according to an equation based on many things including
attacking Pokémon's attack, defending Pokémon's defense, Pokémon types,
attacking Pokémon's move's type and other factors. If the opposing Pokémon
faints (has no HP left), then that is the end of the battle sequence and the
trainer whose Pokémon fainted chooses a new one to switch out. If the
defending Pokémon does not faint, then it loses the appropriate HP and
performs its move. If the then defending Pokémon faints, then the
trainer chooses which Pokémon to send out. This cycle of battle sequences
happen until one trainer has no Pokémon left to send out and the trainer
with Pokémon left is considered the winner.
CONTROLS
--------
#Menu
- Keys
- Arrow Keys to navigate between buttons in the menus
- Space/Enter to select the currently highlighted button and have it operate its function
- Backspace will exit out of a menu if the operation is allowed
- Mouse
- Click to select a button
COMPILING
---------
1. Download and install Java JDK 8
2. Download and install Netbeans
3. Download JarSplice
4. Clone the repository in the directory of your choice
5. In Netbeans, select 'Run > Clean and Build Project'
6. Open JarSplice
1. Select ADD JARS and add the following Jar files (Note: paths are relative to the project folder):
- dist/csci205FinalProject.jar
- dist/lib/commons-lang3-3.4.jar
- dist/lib/ibxm.jar
- dist/lib/jdom-2.0.6.jar
- dist/lib/jinput.jar
- dist/lib/jogg-0.0.7.jar
- dist/lib/jorbis-0.0.15.jar
- dist/lib/lwjgl.jar
- dist/lib/slick.jar
- Select ADD NATIVES and add all of the files found at:
- externals/Slick/native/
- Select MAIN CLASS
- Under Enter Main Class enter:
- Main
- Select Show Options and under Set VM Arguments enter:
- -Djava.library.path="./externals/Slick/native"
- Select CREATE FAT JAR and select the Create Fat Jar button
- Choose where you would like to save the game
RUNNING
-------
- Graphical File System (Finder/Nautilus/Windows Explorer)
1. Navigate to the folder containing the compiled fat jar (see Compiling for details)
2. Make sure the file has run permissions
3. Double click on the file
- Command Line
1. Navigate to the folder containing the compiled fat jar (see Compiling for details)
2. Make sure the file has run permissions
3. Run java -jar [your_fat_jar_filename].jar
FEATURES
--------
- [x] Splash screen
- [x] Pokémon and trainer objects
- [x] Battle calculator and interactions
- [x] Load Pokémon data from XML
- [x] Battle GUI
- [x] Simple Animations
- [x] Sound & Music
- [x] Main Menu
- [ ] Overworld GUI
- [ ] Overworld interactions
CREDITS
-------
- Special thanks to all of the Bucknell University professors that let us use their names in
the game
- This project uses the Slick2D Engine (http://slick.ninjacave.com/ "Slick2D Website"),
a wrapper around the Lightweight Java Game Library (https://www.lwjgl.org/ "LWJGL Website")
- For parsing the XML files, we used JDOM (http://www.jdom.org/)
- All Pokemon sprites were found at Veekun (http://veekun.com/dex/downloads)
- Thanks to cathyjf and r4vi on Github for the moves Database (https:/cathyjf/PokemonLabBot/blob/master/moves.xml)
and Pokémon Database (https:/r4vi/zipper-demo/blob/master/resources/pokemon.xml) respectively
- Trainer Sprites were found on [Psypokes.com](http://i32.tinypic.com/n4blzt.jpg "Psypokes")
DISCLAIMER
----------
This game does not represent the views of Bucknell University or Nintendo Co., Ltd.
Pokémon and its trademarks are ©1995-2016 Nintendo, Creatures, GAMEFREAK and the The Pokémon Company International, Inc. All images in this game are © of their respective owners. Pokemon Orange and Blue is a non-commercial Pokémon® fan game, and means no copyright infringement.