mirror of
https://github.com/Ellpeck/MLEM.git
synced 2024-11-24 21:48:35 +01:00
Compare commits
No commits in common. "b6882a879b5b86df3d592715b079717256a55afe" and "e5593f2132cb372bc8ea99086b3ffdc70023b9f2" have entirely different histories.
b6882a879b
...
e5593f2132
5 changed files with 15 additions and 11 deletions
|
@ -1,9 +1,9 @@
|
|||
# MLEM.Startup
|
||||
|
||||
**MLEM.Startup** is a simple package that contains a `MlemGame` class which extends MonoGame's `Game`. This class contains additional properties that most games created with MonoGame and MLEM will have:
|
||||
- An [InputHandler](xref:MLEM.Input.InputHandler)
|
||||
- An [InputHandler](https://github.com/Ellpeck/MLEM/wiki/Input-Handler)
|
||||
- A `SpriteBatch` and `GraphicsDeviceManager`
|
||||
- A [UiSystem](ui.md)
|
||||
- A [UiSystem](https://github.com/Ellpeck/MLEM/wiki/MLEM.Ui)
|
||||
- Some delegate callbacks for loading, updating and drawing that allow additional code to be executed from outside the game class
|
||||
|
||||
Additionally, it comes with the [Coroutine](https://www.nuget.org/packages/Coroutine) package preinstalled. The Coroutine package allows creating and running operations alongside the regular game loop without asynchrony. It comes with a `CoroutineEvents` class that contains two types of events that are automatically invoked by `MlemGame`. For more information on how this is useful, see [the Coroutine README](https://github.com/Ellpeck/Coroutine/blob/main/README.md).
|
|
@ -4,7 +4,7 @@ The **MLEM** package contains a simple text formatting system that supports colo
|
|||
|
||||
Text formatting makes use of [generic fonts](font_extensions.md).
|
||||
|
||||
It should also be noted that [MLEM.Ui](ui.md)'s `Paragraph`s support text formatting out of the box.
|
||||
It should also be noted that [MLEM.Ui](https://github.com/Ellpeck/MLEM/wiki/MLEM.Ui)'s `Paragraph`s support text formatting out of the box.
|
||||
|
||||
*This documentation is about the new text formatting that was introduced in MLEM 3.3.1. You can see the documentation for the legacy text formatting system [here](text_formatting_legacy.md).*
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ The **MLEM** package contains a simple text formatting system that supports colo
|
|||
|
||||
Text formatting makes use of [generic fonts](font_extensions.md).
|
||||
|
||||
It should also be noted that [MLEM.Ui](ui.md)'s `Paragraph`s support text formatting out of the box.
|
||||
It should also be noted that [MLEM.Ui](https://github.com/Ellpeck/MLEM/wiki/MLEM.Ui)'s `Paragraph`s support text formatting out of the box.
|
||||
|
||||
## Formatting codes
|
||||
To format your text, you can insert *formatting codes* into it. These codes are surrounded by `[]` by default, however these delimiters can be changed like so:
|
||||
|
@ -23,7 +23,7 @@ By default, the following formatting options are available:
|
|||
## Getting your text ready
|
||||
To actually display the text with formatting, you first need to gather the formatting data from the text. For performance reasons, this is best done when the text changes, and not every render frame.
|
||||
|
||||
To gather formatting data, you will need a [generic font](font_extensions.md). With it, you can gather the data in the form of a `FormattingCodeCollection` like so:
|
||||
To gather formatting data, you will need a [generic font](https://github.com/Ellpeck/MLEM/wiki/Font-Extensions). With it, you can gather the data in the form of a `FormattingCodeCollection` like so:
|
||||
```cs
|
||||
var font = new GenericSpriteFont(this.Content.Load<SpriteFont>("Fonts/ExampleFont"));
|
||||
var text = "This is the [Blue]text[White] that should be [Wobbly]formatted[Unanimated].";
|
||||
|
|
4
Jenkinsfile
vendored
4
Jenkinsfile
vendored
|
@ -5,7 +5,7 @@ pipeline {
|
|||
steps {
|
||||
sh 'dotnet tool restore'
|
||||
// we use xvfb to allow for graphics-dependent tests
|
||||
sh 'xvfb-run -a dotnet cake --target Publish --branch ' + env.BRANCH_NAME
|
||||
sh 'xvfb-run -a dotnet dotnet-cake --Target=Publish --Branch=' + env.BRANCH_NAME
|
||||
}
|
||||
}
|
||||
stage('Document') {
|
||||
|
@ -13,7 +13,7 @@ pipeline {
|
|||
branch 'release'
|
||||
}
|
||||
steps {
|
||||
sh 'dotnet cake --target Document'
|
||||
sh 'dotnet dotnet-cake --Target=Document'
|
||||
sh 'cp Docs/_site/** /var/www/MLEM/ -r'
|
||||
}
|
||||
}
|
||||
|
|
|
@ -66,11 +66,13 @@ namespace MLEM.Misc {
|
|||
/// <summary>
|
||||
/// The MLEM DesktopGL platform.
|
||||
/// This platform uses the built-in MonoGame TextInput event, which makes this listener work with any keyboard localization natively.
|
||||
/// </summary>
|
||||
/// <example>
|
||||
/// This platform is initialized as follows:
|
||||
/// <code>
|
||||
/// MlemPlatform.Current = new MlemPlatform.DesktopGl<TextInputEventArgs>((w, c) => w.TextInput += c);
|
||||
/// new MlemPlatform.DesktopGl{TextInputEventArgs}((w, c) => w.TextInput += c)
|
||||
/// </code>
|
||||
/// </summary>
|
||||
/// </example>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public class DesktopGl<T> : MlemPlatform {
|
||||
|
||||
|
@ -114,11 +116,13 @@ namespace MLEM.Misc {
|
|||
/// The MLEM platform for mobile platforms as well as consoles.
|
||||
/// This platform opens an on-screen keyboard using the <see cref="Microsoft.Xna.Framework.Input"/> <c>KeyboardInput</c> class on mobile devices.
|
||||
/// Additionally, it starts a new activity whenever <see cref="OpenLinkOrFile"/> is called.
|
||||
/// </summary>
|
||||
/// <example>
|
||||
/// This listener is initialized as follows in the game's <c>Activity</c> class:
|
||||
/// <code>
|
||||
/// MlemPlatform.Current = new MlemPlatform.Mobile(KeyboardInput.Show, l => this.StartActivity(new Intent(Intent.ActionView, Uri.Parse(l))));
|
||||
/// new MlemPlatform.Mobile(KeyboardInput.Show, l => this.StartActivity(new Intent(Intent.ActionView, Uri.Parse(l))))
|
||||
/// </code>
|
||||
/// </summary>
|
||||
/// </example>
|
||||
public class Mobile : MlemPlatform {
|
||||
|
||||
private readonly OpenOnScreenKeyboardDelegate openOnScreenKeyboard;
|
||||
|
|
Loading…
Reference in a new issue