diff --git a/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png b/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png new file mode 100644 index 000000000..12b29991f Binary files /dev/null and b/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png b/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png index 12b29991f..d77d71193 100644 Binary files a/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png and b/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1).png b/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1).png index d77d71193..3e959d7cd 100644 Binary files a/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1).png and b/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/image (1) (1) (1) (1) (1).png b/docs/.gitbook/assets/image (1) (1) (1) (1) (1).png index 3e959d7cd..2f6e8a859 100644 Binary files a/docs/.gitbook/assets/image (1) (1) (1) (1) (1).png and b/docs/.gitbook/assets/image (1) (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/image (1) (1) (1) (1).png b/docs/.gitbook/assets/image (1) (1) (1) (1).png index 2f6e8a859..1a7c8c78c 100644 Binary files a/docs/.gitbook/assets/image (1) (1) (1) (1).png and b/docs/.gitbook/assets/image (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/image (1) (1) (1).png b/docs/.gitbook/assets/image (1) (1) (1).png index 1a7c8c78c..60f4b884c 100644 Binary files a/docs/.gitbook/assets/image (1) (1) (1).png and b/docs/.gitbook/assets/image (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/image (1) (1).png b/docs/.gitbook/assets/image (1) (1).png index 60f4b884c..bb9d7301c 100644 Binary files a/docs/.gitbook/assets/image (1) (1).png and b/docs/.gitbook/assets/image (1) (1).png differ diff --git a/docs/.gitbook/assets/image (1).png b/docs/.gitbook/assets/image (1).png index bb9d7301c..6704b0148 100644 Binary files a/docs/.gitbook/assets/image (1).png and b/docs/.gitbook/assets/image (1).png differ diff --git a/docs/.gitbook/assets/image (2) (1) (1) (1) (1).png b/docs/.gitbook/assets/image (2) (1) (1) (1) (1).png new file mode 100644 index 000000000..aacde0555 Binary files /dev/null and b/docs/.gitbook/assets/image (2) (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/image (2) (1) (1) (1).png b/docs/.gitbook/assets/image (2) (1) (1) (1).png index aacde0555..c38ba429c 100644 Binary files a/docs/.gitbook/assets/image (2) (1) (1) (1).png and b/docs/.gitbook/assets/image (2) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/image (2) (1) (1).png b/docs/.gitbook/assets/image (2) (1) (1).png index c38ba429c..a9a2a2f70 100644 Binary files a/docs/.gitbook/assets/image (2) (1) (1).png and b/docs/.gitbook/assets/image (2) (1) (1).png differ diff --git a/docs/.gitbook/assets/image (2) (1).png b/docs/.gitbook/assets/image (2) (1).png index a9a2a2f70..656152e95 100644 Binary files a/docs/.gitbook/assets/image (2) (1).png and b/docs/.gitbook/assets/image (2) (1).png differ diff --git a/docs/.gitbook/assets/image (2).png b/docs/.gitbook/assets/image (2).png index 656152e95..7e5711c92 100644 Binary files a/docs/.gitbook/assets/image (2).png and b/docs/.gitbook/assets/image (2).png differ diff --git a/docs/.gitbook/assets/image.png b/docs/.gitbook/assets/image.png index 7e5711c92..14617f844 100644 Binary files a/docs/.gitbook/assets/image.png and b/docs/.gitbook/assets/image.png differ diff --git a/docs/README.md b/docs/README.md index b64dd3a0a..7cd72f656 100644 --- a/docs/README.md +++ b/docs/README.md @@ -46,6 +46,6 @@ Gum Application (binaries): [files.flatredball.com/content/Tools/Gum/Gum.zip](ht Gum Source Code: [https://www.github.com/vchelaru/Gum](https://www.github.com/vchelaru/Gum) -Note that Gum uses XNA so the XNA runtime must be installed here: +Note that the Gum tool requires XNA. if you are using the Gum tool, you must install the XNA runtime: [https://www.microsoft.com/en-us/download/details.aspx?id=20914](https://www.microsoft.com/en-us/download/details.aspx?id=20914) diff --git a/docs/gum-elements/component/default-child-container.md b/docs/gum-elements/component/default-child-container.md index cd977a2d8..13914efef 100644 --- a/docs/gum-elements/component/default-child-container.md +++ b/docs/gum-elements/component/default-child-container.md @@ -16,7 +16,7 @@ This Component is designed to keep all of is children inside the InnerRectangle, To make this kind of relationship the default, the Frame can set its Default Child Container property to InnerRectangle. -
+
Once this value is set, instances which are drag+dropped onto Frame instances will use the InnerRectangle as their parent, as shown in the following animation. @@ -28,4 +28,4 @@ When one instance is drag+dropped onto another instance, the Parent property is Using the example above, the RectangleInstance is dropped on the ContainerTestInstance. Since the ContainerTestInstance is of type Frame, then the Default Child Container is applied on the drop, which results in the RectangleInstance's Parent being set to ContainerTestInstance.InnerRectangle. -
+
diff --git a/docs/gum-elements/container/children-layout.md b/docs/gum-elements/container/children-layout.md index ebc4f437a..c4c110d2a 100644 --- a/docs/gum-elements/container/children-layout.md +++ b/docs/gum-elements/container/children-layout.md @@ -22,7 +22,7 @@ Top to Bottom Stack results in each child being positioned after its previous si Left to Right Stack results in each child being positioned after its previous sibling horizontally. This can be used to create vertical stacks quickly. -
+
### Stacking and Units diff --git a/docs/gum-elements/container/stack-spacing.md b/docs/gum-elements/container/stack-spacing.md index 9acf4c7d9..b729a304c 100644 --- a/docs/gum-elements/container/stack-spacing.md +++ b/docs/gum-elements/container/stack-spacing.md @@ -8,7 +8,7 @@ The Stack Spacing variable controls the additional padding between children when A larger Stack Spacing value increases the spacing between each child. By default Stack Spacing is set to 0 which means that no spacing is added between items in a stack. -
+
Changing the stack spacing adds gaps between each child as shown in the following animation. diff --git a/docs/gum-elements/general-properties/y-origin.md b/docs/gum-elements/general-properties/y-origin.md index e26ff49d0..f3bc7fe2c 100644 --- a/docs/gum-elements/general-properties/y-origin.md +++ b/docs/gum-elements/general-properties/y-origin.md @@ -32,7 +32,7 @@ Baseline refers to the bottom of the text for letters without descenders. For mo Baseline is often used to align fonts of different sizes. The following image shows two Text instances with different font sizes. Both are positioned by their baseline so their bottoms align properly (ignoring descenders, such as on the letter p and the comma). -

50,000 xp aligned by baseline

+

50,000 xp aligned by baseline

By contrast, the following image shows the same Text instances using bottom alignment. diff --git a/docs/gum-elements/nineslice/nineslice.texture-address.md b/docs/gum-elements/nineslice/nineslice.texture-address.md index 40e7b2ec9..2d57b8cfa 100644 --- a/docs/gum-elements/nineslice/nineslice.texture-address.md +++ b/docs/gum-elements/nineslice/nineslice.texture-address.md @@ -8,7 +8,7 @@ The **Texture Address** variable can be used to define the area that the NineSli The following screenshot shows an entire texture being used for a NineSlice. -
+
The entire texture is split up into 3 sections horizontally and 3 sections vertically, matching up the texture coordinates used to display the NineSlice's 9 sections. @@ -28,5 +28,5 @@ The NineSlice uses the following variables: These values result in the the following NineSlice: -
+
diff --git a/docs/intro-tutorials/properties-window.md b/docs/intro-tutorials/properties-window.md index 3c1d54af8..6b1886fca 100644 --- a/docs/intro-tutorials/properties-window.md +++ b/docs/intro-tutorials/properties-window.md @@ -58,7 +58,7 @@ To see how this works, select the "Text" item under the "Standard" item. Notice If the default Horizontal Alignment and Vertical Alignment values are changed, the changes will immediately be reflected in the preview window for the default Text configuration: -![](<../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png>) +![](<../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png>) Now if we select the TextIntance we will see that the VerticalAlignment is visibly using the Bottom value; however the **Horizontal Alignment** is still using center - this is because a value that is explicitly set on an instance will always override the default value set in the Standard element. Notice that **Horizontal Alignment** is black (indicating a custom value) and **Vertical Alignment** is green (indicating a default value). diff --git a/docs/menu/project-properties.md b/docs/menu/project-properties.md index 8977b0cd4..d69490619 100644 --- a/docs/menu/project-properties.md +++ b/docs/menu/project-properties.md @@ -22,7 +22,7 @@ The Font Ranges setting controls which characters are included in default fonts. The default Font Ranges value is `32-126,160-255` which maps to the first page of the Bitmap font generator character set, labeled as **Latin + Latin Supplement**. -![](<../.gitbook/assets/image (2) (1) (1) (1).png>) +![](<../.gitbook/assets/image (2) (1) (1) (1) (1).png>) Various websites provide a list of unicode character sets such as [https://unicode-table.com/en/blocks/](https://unicode-table.com/en/blocks/) diff --git a/docs/monogame/loading-.gumx-gum-project.md b/docs/monogame/loading-.gumx-gum-project.md index eaa30fe27..f5d903699 100644 --- a/docs/monogame/loading-.gumx-gum-project.md +++ b/docs/monogame/loading-.gumx-gum-project.md @@ -29,7 +29,7 @@ To add the files to your .csproj: 3. Verify that all gum files (see the extension list above) are marked as Copy if newer in Visual Studio\ -

Gum project set to Copy if newer

+

Gum project set to Copy if newer

### Loading a Gum projecxt diff --git a/docs/monogame/runtime-objects-guederiving/textruntime.md b/docs/monogame/runtime-objects-guederiving/textruntime.md index cff0489a1..283342d80 100644 --- a/docs/monogame/runtime-objects-guederiving/textruntime.md +++ b/docs/monogame/runtime-objects-guederiving/textruntime.md @@ -13,3 +13,35 @@ var textInstance = new TextRuntime(); textInstance.Text = "Hello world"; text.AddToManagers(SystemManagers.Default, null); ``` + +### Fonts + +By default all TextRuntime instances us an Arial 18 pt font. This can be changed by specifying ta custom font. + +Fonts on TextRuntime objects can be modified in one of two ways: + +1. By setting the UseCustomFont property to true, then changing the CustomFontFile property to a desired .fnt file. +2. By setting UseCustomFont property to false, then changing the individual Font values. This approach requires following a specific .fnt naming convention. + +For most projects, the first approach is recommended since it doesn't require specific naming conventions. The second approach is convenient if your project is using the Gum tool, and if the Gum tool has already generated fonts for the specific combinations of values you are assigning. + +The following code shows how to load a custom font: + +```csharp +var customText = new TextRuntime(); +customText.UseCustomFont = true; +customText.CustomFontFile = "WhitePeaberryOutline/WhitePeaberryOutline.fnt"; +customText.Text = "Hello, I am using a custom font"; +container.Children.Add(customText); +``` + +This code assumes a font file named WhitePeaberryOutline.fnt is located in the `Content/WhitePeaberryOutline` folder. By default all Gum content loading is performed relative to the Content folder. + +Note that .fnt files reference one or more image files, so the image file must also be added to the correct folder. In this case, the WhitePeaberryOutline.fnt file references a WhitePeaberryOutline.png file, so both files are in the same folder. + +

WhitePeaberryOutline font in the Solution Explorer

+ +Also, note that files are loaded from-file rather than using the content pipeline. This means that extensions (such as .fnt) are included in the file path, and that both the .fnt and .png files must have their **Copy to Output Directory** value set to **Copy if newer**. + +

Copy if newer property set

+ diff --git a/docs/monogame/setup.md b/docs/monogame/setup.md index 798f0b7a9..e551c3782 100644 --- a/docs/monogame/setup.md +++ b/docs/monogame/setup.md @@ -10,7 +10,7 @@ Note that as of the time of this writing, only MonoGame Desktop GL projects are 2. Add the `Gum.MonoGame` NuGet package\ -
+
### Initializing Gum