Skip to content

Commit 64569ea

Browse files
authored
uppercase Arcade everywhere (#2408)
1 parent bec1d64 commit 64569ea

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+128
-128
lines changed

CHANGELOG.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ easy reference. There may be other behavior changes that could break specific
1717
scenarios, but this section is limited to changes which directly changed the
1818
API in a way that is not compatible with how it was used in 2.6.
1919

20-
* Texture management has completely changed in arcade 3.0. In the past we have
20+
* Texture management has completely changed in Arcade 3.0. In the past we have
2121
cached absolutely everything, something that caused major issues for larger
2222
projects needing to manage memory. Functions like `arcade.load_texture` no
2323
longer cache the texture. See the texture section for more details
@@ -88,7 +88,7 @@ API in a way that is not compatible with how it was used in 2.6.
8888
or Cortex-A76 CPU should work. Use images from 2024 or later for best
8989
results.
9090
* Arcade now supports freely mixing Pyglet and Arcade code. This means you
91-
can freely use pyglet batches, Labels when preferred over arcade's types.
91+
can freely use pyglet batches, Labels when preferred over Arcade's types.
9292
Note that texture/image handling are still separate systems. This is
9393
however a solvable problem for intermediate and advanced users.
9494

@@ -297,7 +297,7 @@ testing, or even just providing feedback. It's hard to keep track of all the
297297
people involved in a release, but we want to thank everyone who has helped
298298
in any shape or form. We appreciate all of you!
299299

300-
The main arcade team:
300+
The main Arcade team:
301301

302302
* [Einar Forselv](https://github.com/einarf)
303303
* [pushfoo](https://github.com/pushfoo)

CHANGELOG_HISTORY.rst

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Release Note History
33
====================
44

5-
Change log from order arcade versions.
5+
Change log from order Arcade versions.
66

77
Version 2.6.17
88
--------------
@@ -56,7 +56,7 @@ Version 2.6.14
5656
* :py:class:`~arcade.Camera` should no longer apply zoom on the z axis
5757
* Promote using :py:meth:`arcade.View.on_show_view` in examples
5858
and tutorials
59-
* The arcade window and views now expose :py:meth:`arcade.Window.on_enter`
59+
* The Arcade window and views now expose :py:meth:`arcade.Window.on_enter`
6060
:py:meth:`arcade.Window.on_leave`. These events are triggered
6161
when the mouse enters and leaves the window area.
6262
* Sections should now also support mouse enter/leave events
@@ -69,7 +69,7 @@ Version 2.6.14
6969
* Removed ``Texture.draw_transformed``
7070
* Add support for changing the pitch while playing a sound. See the `speed` parameter in
7171
:py:func:`arcade.play_sound`.
72-
* Set better blending defaults for arcade GUI
72+
* Set better blending defaults for Arcade GUI
7373
* Can now create a texture filled with a single color. See :py:meth:`Texture.create_filled`.
7474
The Sprite class will use this when creating a solid colored sprite.
7575
* Bump version numbers of Sphinx, Pillow to current release as of 17-May.
@@ -93,7 +93,7 @@ Version 2.6.14
9393
* Docs / Tutorials / Examples
9494

9595
* Updated install docs
96-
* Added tutorial for compiling an arcade game with Nuika
96+
* Added tutorial for compiling an Arcade game with Nuitka
9797
* Improved/extended shadertoy tutorials
9898
* Added example using textures with shadertoy
9999
* Added sprite rotation examples
@@ -398,7 +398,7 @@ Version 2.6.10
398398
* Fixed a bug causing sprites to have incorrect scale when passing a texture
399399
during creation.
400400
* Removed the texture transform feature in sprites. This feature no longer
401-
makes sense since arcade 2.6.0 due to the new texture atlas feature.
401+
makes sense since Arcade 2.6.0 due to the new texture atlas feature.
402402

403403
* Tiled Maps
404404

@@ -586,9 +586,9 @@ Version 2.6.6
586586
* Window:
587587

588588
* Added ``samples`` parameter so user can specify antialiasing quality.
589-
* The arcade window should fall back to no antialiasing if the window
589+
* The Arcade window should fall back to no antialiasing if the window
590590
creation fails. Some drivers/hardware don't support it. For example
591-
when running arcade in WSL or services like Repl.it.
591+
when running Arcade in WSL or services like Repl.it.
592592

593593
* SpriteList
594594

@@ -1046,7 +1046,7 @@ Version 2.5.7
10461046
Fixes
10471047
~~~~~
10481048

1049-
* The arcade gui should now respect the current viewport
1049+
* The Arcade gui should now respect the current viewport
10501050
* Fixed an issue with UILabel allocating large amounts of
10511051
textures over time consuming a lot of memory
10521052
* Fixed an issue with the initial viewport sometimes being
@@ -1063,7 +1063,7 @@ New Features
10631063
**replit.com**
10641064

10651065
Arcade should now work out of the box on replit.com. We detect
1066-
when arcade runs in replit tweaking various settings. One important
1066+
when Arcade runs in replit tweaking various settings. One important
10671067
setting we disable is antialiasing since this doesn't work
10681068
well with software rendering.
10691069

@@ -1380,7 +1380,7 @@ Version 2.4 Under-the-hood improvements
13801380
A brand new low level rendering API wrapping OpenGL 3.3 core was added in this release.
13811381
It's loosely based on the `ModernGL <https://github.com/moderngl/moderngl>`_ API,
13821382
so ModernGL users should be able to pick it up fast.
1383-
This API is used by arcade for all the higher level drawing functionality, but
1383+
This API is used by Arcade for all the higher level drawing functionality, but
13841384
can also be used by end users to really take advantage of their GPU. More
13851385
guides and tutorials around this is likely to appear in the future.
13861386

@@ -1390,7 +1390,7 @@ A simplified list of features in the new API:
13901390
introduced and can be found through the ``window.ctx`` property.
13911391
This object offers methods to create opengl resources such as textures,
13921392
programs/shaders, framebuffers, buffers and queries. It also has shortcuts for changing
1393-
various context states. When working with OpenGL in arcade you are encouraged to use
1393+
various context states. When working with OpenGL in Arcade you are encouraged to use
13941394
``arcade.gl`` instead of ``pyglet.gl``. This is important as the context is doing
13951395
quite a bit of bookkeeping to make our life easier.
13961396
* New :py:class:`~arcade.gl.Texture` class supporting a wide variety of formats such as 8/16/32 bit
@@ -1723,7 +1723,7 @@ Version 2.2.0
17231723
* Enhancement: Added ``load_spritesheet`` for loading images from a sprite sheet
17241724
* Enhancement: Updates to physics engine to better handle non-rectangular sprites
17251725
* Enhancement: Add SpriteSolidColor class, for creating a single-color rectangular sprite
1726-
* Enhancement: Expose type hints to modules that depend on arcade via PEP 561
1726+
* Enhancement: Expose type hints to modules that depend on Arcade via PEP 561
17271727
`Issue 533 <https://github.com/pvcraven/arcade/issues/533>`_
17281728
and `Issue 534 <https://github.com/pvcraven/arcade/issues/534>`_
17291729
* Enhancement: Add font_color to gui.TextButton init `Issue 521 <https://github.com/pvcraven/arcade/issues/521>`_
@@ -1766,7 +1766,7 @@ Version 2.1.5
17661766
Version 2.1.4
17671767
-------------
17681768

1769-
* Fix: Error when importing arcade on Raspberry Pi 4 `Issue 485 <https://github.com/pvcraven/arcade/issues/485>`_
1769+
* Fix: Error when importing Arcade on Raspberry Pi 4 `Issue 485 <https://github.com/pvcraven/arcade/issues/485>`_
17701770
* Fix: Transparency not working in draw functions `Issue 489 <https://github.com/pvcraven/arcade/issues/489>`_
17711771
* Fix: Order of parameters in draw_ellipse documentation `Issue 490 <https://github.com/pvcraven/arcade/issues/490>`_
17721772
* Raise better error on data classes missing

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ is also strongly recommended.
5757
## Installing Arcade in Editable Mode
5858

5959
To install all necessary development dependencies, run this command in your
60-
terminal from inside the top level of the arcade directory:
60+
terminal from inside the top level of the Arcade directory:
6161

6262
```bash
6363
pip install -e '.[dev]'
@@ -325,6 +325,6 @@ To enable this feature, most users can follow these steps:
325325
2. If it is one of the supported shells, run `./make.py --install-completion $(basename "$SHELL")`
326326
3. Restart your terminal
327327

328-
If your default shell is not the shell you prefer using for arcade development,
328+
If your default shell is not the shell you prefer using for Arcade development,
329329
you may need to specify it to the command above directly instead of using
330330
auto-detection.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Preview the next release at https://api.arcade.academy/en/development/.
3131
```
3232
@Online{PythonArcade,
3333
author = {Paul Vincent Craven},
34-
title = {Easy to use Python library for creating 2D arcade games.},
34+
title = {Easy to use Python library for creating 2D Arcade games.},
3535
date = {2023-01-01},
3636
publisher = {GitHub},
3737
journal = {GitHub repository},

arcade/application.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -570,7 +570,7 @@ def on_mouse_press(self, x: int, y: int, button: int, modifiers: int) -> bool |
570570
Called once whenever a mouse button gets pressed down.
571571
572572
Override this function to handle mouse clicks. For an example of
573-
how to do this, see arcade's built-in :ref:`aiming and shooting
573+
how to do this, see Arcade's built-in :ref:`aiming and shooting
574574
bullets <sprite_bullets_aimed>` demo.
575575
576576
Args:
@@ -1329,7 +1329,7 @@ def on_mouse_press(self, x: int, y: int, button: int, modifiers: int) -> bool |
13291329
Called once whenever a mouse button gets pressed down.
13301330
13311331
Override this function to handle mouse clicks. For an example of
1332-
how to do this, see arcade's built-in :ref:`aiming and shooting
1332+
how to do this, see Arcade's built-in :ref:`aiming and shooting
13331333
bullets <sprite_bullets_aimed>` demo.
13341334
13351335
Args:

arcade/cache/texture.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ def __len__(self) -> int:
8080

8181
class TextureCache:
8282
"""
83-
A cache for arcade textures.
83+
A cache for Arcade textures.
8484
8585
The creation of a texture is an expensive operation for several reasons.
8686
* Loading an image from disk has a cost

arcade/camera/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This is an overview of how the new Arcade Cameras work.
55
## Key Concepts
66

77
### World Space
8-
Whenever an object has a position within arcade that position is in world space. How much 1 unit in world
8+
Whenever an object has a position within Arcade that position is in world space. How much 1 unit in world
99
space represents is arbitrary. For example when a sprite has a scale of 1.0 then 1 unit in world space is
1010
equal to one pixel of the sprite's source texture. This does not necessarily equate to one pixel on the screen.
1111

arcade/camera/default.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ def unproject(self, screen_coordinate: Point) -> Vec3:
104104
class DefaultProjector(ViewportProjector):
105105
"""
106106
An extremely limited projector which lacks any kind of control. This is only
107-
here to act as the default camera used internally by arcade. There should be
107+
here to act as the default camera used internally by Arcade. There should be
108108
no instance where a developer would want to use this class.
109109
110110
Args:

arcade/clock.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ class Clock:
1414
Arcade provides a global clock which is automatically ticked by the window.
1515
1616
*Coming post 3.0:*
17-
you can add 'sub-clocks' to arcade's top level clock which will tick at the
17+
you can add 'sub-clocks' to Arcade's top level clock which will tick at the
1818
same time, and have cumulative tick_speeds. This allows you to slow down
1919
only certain elements rather than everything.
2020
@@ -181,7 +181,7 @@ def fraction(self) -> float:
181181

182182
def _setup_clock(initial_elapsed: float = 0.0, initial_tick: int = 0, tick_speed: float = 1.0):
183183
"""
184-
Private method used by the arcade window to setup the global clock post initialization.
184+
Private method used by the Arcade window to setup the global clock post initialization.
185185
186186
Args:
187187
initial_elapsed: The amount of time the clock should assume
@@ -199,7 +199,7 @@ def _setup_clock(initial_elapsed: float = 0.0, initial_tick: int = 0, tick_speed
199199

200200
def _setup_fixed_clock(fixed_tick_rate: float = 1.0 / 60.0):
201201
"""
202-
Private method used by the arcade window to setup the global fixed clock
202+
Private method used by the Arcade window to setup the global fixed clock
203203
post initialization.
204204
205205
Args:

arcade/context.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ def default_atlas(self) -> TextureAtlasBase:
247247
"""
248248
The default texture atlas.
249249
250-
This is created when arcade is initialized.
250+
This is created when Arcade is initialized.
251251
All sprite lists will use use this atlas unless a different atlas
252252
is passed in the :py:class:`arcade.SpriteList` constructor.
253253
"""

arcade/draw/circle.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def draw_circle_filled(
3131
num_segments:
3232
Number of triangle segments that make up this circle.
3333
Higher is better quality, but slower render time.
34-
The default value of -1 means arcade will try to calculate a reasonable
34+
The default value of -1 means Arcade will try to calculate a reasonable
3535
amount of segments based on the size of the circle.
3636
"""
3737
draw_ellipse_filled(
@@ -75,7 +75,7 @@ def draw_circle_outline(
7575
num_segments:
7676
Number of triangle segments that make up this circle.
7777
Higher is better quality, but slower render time.
78-
The default value of -1 means arcade will try to calculate a reasonable
78+
The default value of -1 means Arcade will try to calculate a reasonable
7979
amount of segments based on the size of the circle.
8080
"""
8181
draw_ellipse_outline(
@@ -123,7 +123,7 @@ def draw_ellipse_filled(
123123
num_segments:
124124
Number of triangle segments that make up this circle.
125125
Higher is better quality, but slower render time.
126-
The default value of -1 means arcade will try to calculate a reasonable
126+
The default value of -1 means Arcade will try to calculate a reasonable
127127
amount of segments based on the size of the circle.
128128
"""
129129
# Fail immediately if we have no window or context
@@ -182,7 +182,7 @@ def draw_ellipse_outline(
182182
num_segments:
183183
Number of triangle segments that make up this circle.
184184
Higher is better quality, but slower render time.
185-
The default value of -1 means arcade will try to calculate a reasonable
185+
The default value of -1 means Arcade will try to calculate a reasonable
186186
amount of segments based on the size of the circle.
187187
"""
188188
# Fail immediately if we have no window or context

arcade/draw/helpers.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ def _generic_draw_line_strip(
7070
rgba = Color.from_iterable(color)
7171
num_vertices = len(point_list) # Fail if it isn't a sized / sequence object
7272

73-
# Translate Python objects into types arcade's Buffer objects accept
73+
# Translate Python objects into types Arcade's Buffer objects accept
7474
color_array = array.array("B", rgba * num_vertices)
7575
vertex_array = array.array("f", tuple(item for sublist in point_list for item in sublist))
7676
geometry.num_vertices = num_vertices

arcade/examples/conway_alpha.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
This code shows how to set up sprites in a grid, and then use their
55
'alpha' value to quickly turn them on and off.
66
7-
After installing the "arcade" package version 2.4.4+, this program can be run by
7+
After installing the `arcade` package version 2.4.4+, this program can be run by
88
typing:
99
python -m arcade.examples.conway_alpha
1010
"""

arcade/examples/drawing_primitives.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"""
1717

1818
# Import the Arcade library. If this fails, then try following the instructions
19-
# for how to install arcade:
19+
# for how to install Arcade:
2020
# https://api.arcade.academy/en/latest/install/index.html
2121
import arcade
2222

arcade/examples/drawing_text.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
DEFAULT_LINE_HEIGHT = 45
1313
DEFAULT_FONT_SIZE = 20
1414

15-
# Load fonts bumbled with arcade such as the Kenney fonts
15+
# Load fonts bumbled with Arcade such as the Kenney fonts
1616
arcade.resources.load_system_fonts()
1717

1818

arcade/examples/drawing_text_objects.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
DEFAULT_LINE_HEIGHT = 45
1414
DEFAULT_FONT_SIZE = 20
1515

16-
# Load fonts bumbled with arcade such as the Kenney fonts
16+
# Load fonts bumbled with Arcade such as the Kenney fonts
1717
arcade.resources.load_system_fonts()
1818

1919

arcade/examples/drawing_text_objects_batch.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
by using pyglet's batch functionality.
66
77
Although pyglet's batches do not support non-drawing features like
8-
arcade's SpriteList, they offer similar benefits for drawing. Adding
8+
Arcade's SpriteList, they offer similar benefits for drawing. Adding
99
arcade.Text objects to a batch allows drawing thousands of them with
1010
almost the same cost as drawing a single one directly.
1111
@@ -15,7 +15,7 @@
1515
import arcade
1616
from pyglet.graphics import Batch
1717

18-
# Load fonts bumbled with arcade such as the Kenney fonts
18+
# Load fonts bumbled with Arcade such as the Kenney fonts
1919
arcade.resources.load_system_fonts()
2020

2121
WINDOW_WIDTH = 1280 # Window width in pixels

arcade/examples/gl/bindless_texture.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ def __init__(self):
145145

146146
self.handles = []
147147
self.textures: List[Texture2D] = []
148-
# Make a cycle iterator from arcade's resources (images)
148+
# Make a cycle iterator from Arcade's resources (images)
149149
resources = arcade.resources.list_built_in_assets(name="female", extensions=(".png",))
150150
resource_cycle = cycle(resources)
151151

arcade/examples/gui/0_basic_setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Demonstrates general setup.
22
3-
If arcade and Python are properly installed, you can run this example with:
3+
If Arcade and Python are properly installed, you can run this example with:
44
python -m arcade.examples.gui.0_basic_setup
55
66
Content:

arcade/examples/gui/1_layouts.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Demonstrates the use of layouts.
22
3-
If arcade and Python are properly installed, you can run this example with:
3+
If Arcade and Python are properly installed, you can run this example with:
44
python -m arcade.examples.gui.1_layouts
55
66
Content:

arcade/examples/gui/2_widgets.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
See the other GUI examples for more indepth information about specific widgets.
44
5-
If arcade and Python are properly installed, you can run this example with:
5+
If Arcade and Python are properly installed, you can run this example with:
66
python -m arcade.examples.gui.2_widgets
77
"""
88

arcade/examples/gui/3_buttons.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
"""Customizing buttons with text & textures.
22
3-
This example showcases arcade's range of different built-in button types
3+
This example showcases Arcade's range of different built-in button types
44
and how they can be used to customize a UI. A UIGridLayout is used to
55
arrange buttons.
66
7-
If arcade and Python are properly installed, you can run this example with:
7+
If Arcade and Python are properly installed, you can run this example with:
88
python -m arcade.examples.gui.3_buttons
99
"""
1010

arcade/examples/gui/4_with_camera.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
At the beginning of the game, the UI camera is used, to apply some animations.
88
9-
If arcade and Python are properly installed, you can run this example with:
9+
If Arcade and Python are properly installed, you can run this example with:
1010
python -m arcade.examples.gui.4_with_camera
1111
"""
1212

0 commit comments

Comments
 (0)