§Play Requirements
A Play application only needs to include the Play JAR files to run properly. These JAR files are published to the Maven Repository so you can use any Java or Scala build tool to build a Play project. However, Play provides an enhanced development experience (support for routes, templates compilation and auto-reloading) when using the sbt or Gradle build tools.
Play requires:
- Java SE 1.8 or higher
- A build tool. Choose from:
§Verifying and installing Java
To check that you have Java SE 1.8 or higher, enter the following in a terminal:
java -version
You should see something like:
java version "1.8.0_121"
Java(TM) SE Runtime Environment (build 1.8.0_121-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.121-b13, mixed mode)
You can obtain Java SE from Oracle’s JDK Site.
§Verifying and installing sbt
Play example projects available from Lightbend Tech Hub automatically download dependencies and have ./sbt and sbt.bat launchers for Unix and Windows environments, respectively. You do not have to install sbt to run them.
If you want to use sbt to create a new project, you need to install the sbt launcher on your system. With sbt installed, you can use our giter8 template for Java or Scala to create your own project with a single command, using sbt new. Find the links on the sbt download page to install the sbt launcher on your system and refer to the sbt documentation for details about how to set it up.
§Verifying and installing Gradle
Play example projects available from Lightbend Tech Hub automatically download dependencies and have ./gradlew or gradlew.bat launchers for Unix and Windows environments, respectively. You do not need to install Gradle to run them.
If you are ready to start your own project and want to use Gradle, refer to the Gradle install page to install Gradle launcher on your system. If you run into problems after installing, check Gradle’s documentation for help. We recommend that you use the latest version of Gradle.
§Congratulations!
You are now ready to work with Play! to learn about Play hands-on, try the examples as described on the next page. If you have sbt installed, you can create a new Play project with a single command, using our giter8 Java or Scala template. The templates set up the project structure and dev environment for you. You can also easily integrate Play projects into your favorite IDE.
Found an error in this documentation? The source code for this page can be found here. After reading the documentation guidelines, please feel free to contribute a pull request. Have questions or advice to share? Go to our community forums to start a conversation with the community.