Add more (empty) pages and links to them on "Home".

Kai Blaschke 2021-11-17 17:40:50 +01:00
parent 81f410ae07
commit fc16ab614f
No known key found for this signature in database
GPG Key ID: B014B6811527389F
7 changed files with 22 additions and 30 deletions

52
Home.md

@ -18,43 +18,35 @@ The Wiki is organized into three main sections:
If you're using one of the "official" projectM applications maintained by this project, you can find documentation for
those applications on the following pages. If you're unsure whether your application is actually affiliated with us,
please check the [applications list](projectM-Applications) first. Only those listed as "provided by the projectM
team" are covered here and can be supported by the maintainers. For all other applications, please refer to their
respective project pages or contact their authors directly for support inquiries.
please check the [applications list](projectM-Applications) first. Only those listed as "provided by the projectM team"
are covered here and can be supported by the maintainers. For all other applications, please refer to their respective
project pages or contact their authors directly for support inquiries.
- [Standalone and Steam applications](User-Manual-(Standalone))
- [EyeTune (Windows Store)](User-Manual-(EyeTune))
- [Music.app Plug-In](User-Manual-(Music.app-PlugIn))
Quick access to the hotkeys:
## Integrating projectM into applications
# Keyboard Controls:
If you are a developer and want to use projectM in your own application or project, that's great! Below you will find
all the required information to get started with the projectM API.
* Up: Increase beat sensitivity (max 5)
* Down: Decrease beat sensitivity (min 0)
* Y: Toggle shuffle enabled
* R: Jump to random preset
* N or P: Next or previous preset (hard transition)
* Shift-N or Shift-P: Next or previous preset (soft transition)
* L: Lock current preset
* Home: Jump to the top of presets
* End: Jump to the bottom of presets
* PageUp: Jump up half a page
* PageDown: Jump down half a page
Before starting, also make sure you have read the LGPL license and understood which obligations you need to follow to
legally use and distribute projectM with your application.
* H or F1: Show help (if supported)
* M: Open preset navigation menu (if supported)
* F3: Show preset (if supported)
* F4: Show stats (if supported)
* F5: Show FPS (if supported)
- [Download and build projectM for application development](Building-libprojectM)
- [projectM API reference](API-Reference)
- [Licensing obligations](projectM-Licensing)
#### Only ProjectM SDL:
## Contributing to projectM
* Cmd/Ctrl-Q: *q*uit
* Cmd/Ctrl-I: select next audio *i*nput device
* Cmd/Ctrl-S: *s*tretch monitors
* Cmd/Ctrl-M: Change *m*onitor
* Cmd/Ctrl-F: Toggle *f*ull screen
* Mouse Scroll Up / Down: next or previous preset (hard transition)
* Return: search for preset (RETURN or ESCAPE to exit search)
* Space: lock current preset
projectM is developed as an open source application and thus anyone can contribute to it! Possible contributions are not
limited to core C++ code though. You can help with documentation, adding new presets, testing reported bugs and many
other things.
The pages below will help you get an overview of the projectM architecture, roadmap and guidelines.
- [Getting started with projectM development](Getting-started-with-projectM) - Read this first if you're new to projectM
and/or OSS development in general.
- [Architectural overview](projectM-Architecture)
- [Coding and contribution guidelines](projectM-Developer-Guidelines)