mirrors/UniversalMediaServer
1
0
Fork 0
mirror of https://github.com/UniversalMediaServer/UniversalMediaServer.git synced 2025-12-03 16:24:00 -05:00
Code Issues Releases Wiki Activity
Page: Development
Pages
. 3D layout from Filename Audio and Subtitles Avisynth ChromeCast Command line arguments Comparison of Media Servers CoreAVC Creating a custom device configuration DVD encryption Development External applications FAQ Firewall Settings General Configuration Headless mode Home How to build UMS How to change to TRACE Logging Index Installation Introduction Links Linux install instructions Mac OS X issue Navigation Share Networking Pushing Media to a Renderer SSL issue Security and Privacy Thanks Transcoding Version 10 Release Notes Video settings VideoLAN Virtual Folders Web interface ~TODO
7 Development
SubJunk edited this page 2024-07-17 14:58:37 +12:00
Table of Contents

Summary

The build instructions describe how to build the latest version of UMS. This document explains how to make and run your own changes.

Forking the code to your machine

GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team.

  • Set up your machine for GitHub development

  • Go to the GitHub UMS repo and press the Fork button on the top right.

  • Clone the new GitHub repo to your local machine. The clone URL can be seen on the main page of your repository. It should be something like this (replace YOURNAME with your actual GitHub name):

      git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME

You now have the new repository on your local machine.

Development with IDEs

VS Code

This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages.

Java server

When you have opened the code, you will probably see some recommendations for Extensions to install, like the Extension Pack for Java. Install it/them. When that is installed and configured, you can run the Java server by clicking up the top Run -> Start Debugging, and reload it with Run -> Restart Debugging. These commands should complete within 1 second, for a fast development workflow.

Web browser interfaces

If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code.

In VS Code, you can go into the Command Palette and filter on Debug: Select and Start Debugging and select Launch web interface. It will automatically reload any changes you make to the React files.

For a manual workflow, you can go into the react-client folder and run yarn to download the necessary dependencies. Then just run yarn dev which should open the web player in the browser and automatically compile any code changes you make.

For the web settings interface, you can open react-client/package.json and change the proxy port from 9002 to 9001. Now yarn dev should serve the web settings instead of web player.

Eclipse

  • Install the m2e Eclipse plugin (http://eclipse.org/m2e/)

  • Install the EGit Eclipse plugin (http://eclipse.org/egit/)

  • In Eclipse, select the menu "Window > Show View > Git Repositories". Then select "Window > Navigation > Show View Menu", choose "Add a Repository". Browse for the directory where you cloned your repository and press the "Search" button. Select your forked repository and press "OK". The repository should appear in the Git Repositories view.

  • Press the right mouse button on the repository and select "Import Maven Projects" from the menu. Select the project "/pom.xml" and press "Finish".

    Note: if a project with the same name already exists, click "Advanced" and set the "Name template" to [artifactId]-YOURNAME (replace YOURNAME with your GitHub name). Then press "Finish".

You now see the sources in Eclipse, but the project is still missing the "Git" nature. In other words, it is not tied to the local repository yet. This means you cannot perform any Git actions from Eclipse yet. Add the missing connection by sharing the project:

  • Press the right mouse button on the newly created project and select the menu "Team > Share Project...". Select "Git" and press "Next >". Check the checkbox "Use or create repository in parent folder of project" and make sure the project is selected. Then press "Finish".

Verify that your project is now under Git control. Press the right mouse button on the project and under "Team" you now see all options to work with Git.

You can build UMS from Eclipse:

  • Create a new run configuration under "Run > Run Configurations...", right mouse button on "Maven Build", select "New", Name: Build UMS, Goals: package. Select the tab "JRE" and add the following VM arguments -Xmx1500m -XX:MaxPermSize=256m. Finally, press the "Apply" button.

You will want to run UMS from Eclipse while developing. This is how you do it:

  • Create a new run configuration under "Run > Run Configurations...", right mouse button on "Maven Build", select "New", Name: Run UMS, Base directory: ${project_loc}, Goals: "test", Profiles: run-from-eclipse. Select the tab "JRE" and add VM arguments -Xmx1500m -XX:MaxPermSize=256m. Finally, press the "Apply" button.

You are now ready to start developing!

When you are happy with your changes, you can commit them to your local repository from Eclipse using right mouse button, "Team > Commit...".

When you are satisfied with your commits and want to publish them to your repository at GitHub, you can press the right mouse button on the project and select "Team > Push to Upstream".

Contributing your change back to us

If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See Creating a Pull Request for more details.