Browse Source

Added README.md

Luiserebii 4 years ago
parent
commit
2c5bf29ab0
1 changed files with 53 additions and 0 deletions
  1. 53
    0
      README.md

+ 53
- 0
README.md View File

@@ -0,0 +1,53 @@
1
+# PokeStat
2
+PokeStat is an app designed for any product supporting Amazon Alexa, which can provide any Pokemon's base stats on demand, including alternate forms, Mega Evolutions, and Primal Reversions! Simply call the app through a phrase like, "Alexa, open PokeStat" and quickly gain access to valuable stat information. It was written using the Amazon Alexa Skills Kit (ASK) and Java for the lambda function, to be run on AWS Lambda.
3
+
4
+<br>
5
+![alt tag](http://sunquyman.xyz/pokestat/img/PokeStatLogo_512x512.png)
6
+<br>
7
+<br>
8
+## Functionality
9
+
10
+PokeStat accepts phrases such as:
11
+* "What are Mega Mewtwo Y's base stats?"
12
+* "What are the base stats of Primal Kyogre?"
13
+* "What base stats does Dragonite have?"
14
+
15
+To end PokeStat, just use any of Alexa's default closing or end phrases. Alternatively, PokeStat has the in-built phrases:
16
+* "Thank you."
17
+* "Thank you, PokeStat."
18
+* "That's enough, PokeStat.:
19
+which will also trigger its end.
20
+
21
+
22
+## File Structure
23
+
24
+The file structure is primarily based on the ASK example folder and Maven build structure.
25
+
26
+<b>src/main/java/pokestat: </b> Holds the source files for the project.
27
+* <b>speechAssets: Contains the IntentSchema, utterances file, and slot type information.</b>
28
+<b>target: </b> Contains the exports of the Maven build, including .jars
29
+<b>pom.xml </b> Simply the Maven pom.xml, build information
30
+
31
+## Building: 
32
+Navigate to the main directory, /pokestat, and run:
33
+$ mvn assembly:assembly -DdescriptorId=jar-with-dependencies package
34
+<br>
35
+
36
+## Future Implementation
37
+* Adding ability to prompt PokeStat for specific stats (e.g. "What is Vaporeon's base HP stat?")
38
+* Pokemon stat analysis function, giving the user a specific Pokemon's stronger stats, its weaker ones, and giving a short analysis on what the user should do if facing the Pokemon.
39
+
40
+
41
+-----------------------------------------------------------------------------------------
42
+
43
+## Appendix
44
+
45
+### A. Pokeapi - Great RESTful Pokemon API, utilized when constructed the database file this application uses: http://pokeapi.co/
46
+
47
+### B. 
48
+
49
+### C. 
50
+
51
+### D.
52
+
53
+

Loading…
Cancel
Save