designer-edu · codeBodger · Dec 5, 2023 · Dec 5, 2023 · Dec 5, 2023
diff --git a/docsrc/students/docs.rst b/docsrc/students/docs.rst
@@ -70,6 +70,7 @@ Creating DesignerObjects
               text(color, text, size)
               text(color, text, size, x, y)
               text(color, text, size, x, y, font_name='Arial')
+              text(color, text, size, x, y, font_name='Arial', font_path=None)
 
     Function to create text on the screen with the given color.
     Not all unicode characters are supported!
@@ -82,8 +83,8 @@ Creating DesignerObjects
 
     :param color: The :ref:`color<color>` of the text
     :type color: str
-    :param message: text to appear on window
-    :type message: str
+    :param text: text to appear on window
+    :type text: str
     :param size: Font size of the text
     :type size: int
     :param x: left most x-coordinate of text
@@ -92,6 +93,8 @@ Creating DesignerObjects
     :type y: int
     :param font_name: The name of the font to use. Defaults to 'Arial'.
     :type font_name: str
+    :param font_path: The path to the font to use. Ignored if font_name is already a font.
+    :type font_path: str
     :return: Text object created
     :rtype: DesignerObject
 

diff --git a/docsrc/students/docs_dictionaries.rst b/docsrc/students/docs_dictionaries.rst
@@ -8,7 +8,7 @@

 .. _image:

 .. function:: image(path)
              image(path, x, y)

    Function to create an image from the given `path`. The `path` given
@@ -40,7 +40,7 @@

 .. _emoji:

 .. function:: emoji(name)
              emoji(name, x, y)

    Function to create an emoji of the given `name`. You can also provide the actual unicode character.
@@ -66,10 +66,11 @@

 .. _text:

 .. function:: text(color, text)
               text(color, text, size)
               text(color, text, size, x, y)
               text(color, text, size, x, y, font_name='Arial')
+              text(color, text, size, x, y, font_name='Arial', font_path=None)
 
     Function to create text on the screen with the given color.
     Not all unicode characters are supported!
@@ -82,8 +83,8 @@
 
     :param color: The :ref:`color<color>` of the text
     :type color: str
-    :param message: text to appear on window
-    :type message: str
+    :param text: text to appear on window
+    :type text: str
     :param size: Font size of the text
     :type size: int
     :param x: left most x-coordinate of text
@@ -92,6 +93,8 @@
     :type y: int
     :param font_name: The name of the font to use. Defaults to 'Arial'.
     :type font_name: str
+    :param font_path: The path to the font to use. Ignored if font_name is already a font.
+    :type font_path: str
     :return: Text object created
     :rtype: DesignerObject
 

diff --git a/docsrc/students/functions.rst b/docsrc/students/functions.rst
@@ -27,6 +27,7 @@ Creating objects
  ``text(color, text, size)``
  ``text(color, text, size, x, y)``
  ``text(color, text, size, x, y, font_name="Arial")``
+ ``text(color, text, size, x, y, font_name="Arial", font_path=None)``
 ====================================================================== =================================================
 
 ====================================================================== =================================================

diff --git a/examples/custom_font_text/OFL.txt b/examples/custom_font_text/OFL.txt
@@ -0,0 +1,93 @@
+Copyright 2020 The Rubik Filtered Project Authors (https://https://github.com/NaN-xyz/Rubik-Filtered)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/examples/custom_font_text/RubikBubbles-Regular.ttf b/examples/custom_font_text/RubikBubbles-Regular.ttf
diff --git a/examples/custom_font_text/custom_font_text.py b/examples/custom_font_text/custom_font_text.py
@@ -0,0 +1,28 @@
+from designer import *
+from dataclasses import dataclass
+
+
+@dataclass
+class World:
+    title: DesignerObject
+    pangram: DesignerObject
+
+
+def create_world() -> World:
+    world = World(
+        text(
+            'black', "Some Sample Text", 30,
+            font_name="RubikBubbles", font_path="RubikBubbles-Regular.ttf"
+        ),
+        text(
+            'black', "The quick brown fox jumps over the lazy dog.",
+            30, font_name="RubikBubbles"
+        )
+    )
+    world.title.y -= 20
+    world.pangram.y += 20
+    return world
+
+
+when('starting', create_world)
+start()