Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 83a0db1

Browse filesBrowse files
ozkriffozkriff
authored
ci.yml: Add markdown-lint (rust-gamedev#190)
1 parent b73264b commit 83a0db1
Copy full SHA for 83a0db1

File tree

16 files changed

+295
-130
lines changed
Filter options

16 files changed

+295
-130
lines changed

‎.github/workflows/ci.yml

Copy file name to clipboardExpand all lines: .github/workflows/ci.yml
+5Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ jobs:
1313
GITHUB_PAT: ${{ secrets.GITHUB_PAT }}
1414
steps:
1515
- uses: actions/checkout@v1
16+
- name: Lint
17+
uses: avto-dev/markdown-lint@v1
18+
with:
19+
args: '.'
20+
config: '.markdownlint.json'
1621
- name: Install Zola
1722
run: curl -L ${BASE_URL}/${VERS}/zola-${VERS}-${ARCH}.tar.gz | tar -xz
1823
- run: ./zola --version

‎.markdownlint.json

Copy file name to clipboard
+12Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"line-length": {
3+
"line_length": 80,
4+
"code_blocks": false
5+
},
6+
"ul-style": {
7+
"style": "dash"
8+
},
9+
"no-trailing-punctuation": {
10+
"punctuation": ".,;:。，；："
11+
}
12+
}

‎README.md

Copy file name to clipboardExpand all lines: README.md
+24-17Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,40 @@
22

33
## Newsletter Creation Workflow
44

5-
* At the beginning of the month, a draft of the newsletter is created
5+
- At the beginning of the month, a draft of the newsletter is created
66
from a [template](./newsletter-template.md).
7-
* This should be called `index.md`, and placed in a folder named
7+
- This should be called `index.md`, and placed in a folder named
88
`/posts/newsletter-xxx` (where `xxx` is the issue number).
9-
* During the month PRs with the month's news, meeting notes, etc
9+
- During the month PRs with the month's news, meeting notes, etc
1010
are reviewed and merged into the draft.
11-
* All images should be placed in the same folder as the post.
12-
* Check the comments in the draft file.
13-
* At the end of the month, the draft is reviewed as a whole
11+
- All images should be placed in the same folder as the post.
12+
- Check the comments in the draft file.
13+
- At the end of the month, the draft is reviewed as a whole
1414
and polished if needed.
15-
* On the first working day of the next month, the final PR
16-
(that removes `draft = true` from the post's front matter and adds the date) is sent.
17-
* The link to the newsletter is shared on social networks, etc.
18-
* A small PR that adds links to Reddit, Twitter, etc discussions
15+
- On the first working day of the next month, the final PR
16+
(that removes `draft = true` from the post's front matter and adds the date)
17+
is sent.
18+
- The link to the newsletter is shared on social networks, etc.
19+
- A small PR that adds links to Reddit, Twitter, etc discussions
1920
(see the comment at the bottom of the draft) is made.
20-
* A new draft for the next month is created from the template, goto 1.
21+
- A new draft for the next month is created from the template, goto 1.
2122

2223
## License
2324

2425
This project is licensed under either of:
2526

26-
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
27-
http://www.apache.org/licenses/LICENSE-2.0)
28-
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
29-
http://opensource.org/licenses/MIT)
27+
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
28+
<http://www.apache.org/licenses/LICENSE-2.0>)
29+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
30+
<http://opensource.org/licenses/MIT>)
3031

3132
With the exception of:
3233

33-
* The [Font Awesome](https://fontawesome.com) social icons, which are used under a [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) license
34-
* The [OpenMoji](https://openmoji.org) icons used on the homepage, which are used under a [Creative Commons Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) license
34+
- The [Font Awesome](https://fontawesome.com) social icons, which are used
35+
under a [Creative Commons Attribution 4.0 International][cc-by-4-0] license
36+
- The [OpenMoji](https://openmoji.org) icons used on the homepage,
37+
which are used under
38+
a [Creative Commons Attribution-ShareAlike 4.0 International][cc-by-sa-4-0] license
39+
40+
[cc-by-4-0]: https://creativecommons.org/licenses/by/4.0
41+
[cc-by-sa-4-0]: https://creativecommons.org/licenses/by-sa/4.0

‎content/posts/2019-08-18-introducing-the-rust-game-development-working-group.md

Copy file name to clipboardExpand all lines: content/posts/2019-08-18-introducing-the-rust-game-development-working-group.md
+45-13Lines changed: 45 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,57 @@ title = "Introducing the Rust Game Development Working Group"
33
aliases = ["/2019/08/18/introducing-the-rust-game-development-working-group", "/2019/08/18/introducing-the-rust-game-development-working-group.html"]
44
+++
55

6-
Rust's combination of low-level control, excellent performance and modern build tools makes it an exciting choice for game developers. The idea of a working group to support this burgeoning community has been proposed [many](https://internals.rust-lang.org/t/a-working-group-for-rust-game-development/8240/4) [times](https://alexene.dev/2018/11/15/Rust-and-game-development.html) over the years, and we're excited to announce that a group has finally been formed!
7-
8-
[Our charter](https://github.com/rust-gamedev/wg/blob/master/charter.md) sets out two primary goals:
9-
10-
* To improve the experience of people using Rust for game development. We want game developers to have a representation in the Rust project. We are a bridge between them and the Rust dev team.
11-
* To share knowledge and make game engine development more accessible for people that are not engine developers. We know it can be a large and intimidating field when you're just starting out.
6+
Rust's combination of low-level control, excellent performance
7+
and modern build tools makes it an exciting choice for game developers.
8+
The idea of a working group to support this burgeoning community has been proposed
9+
[many](https://internals.rust-lang.org/t/a-working-group-for-rust-game-development/8240/4)
10+
[times](https://alexene.dev/2018/11/15/Rust-and-game-development.html)
11+
over the years, and we're excited to announce that a group has finally been formed!
12+
13+
[Our charter](https://github.com/rust-gamedev/wg/blob/master/charter.md)
14+
sets out two primary goals:
15+
16+
- To improve the experience of people using Rust for game development.
17+
We want game developers to have a representation in the Rust project.
18+
We are a bridge between them and the Rust dev team.
19+
- To share knowledge and make game engine development more accessible
20+
for people that are not engine developers.
21+
We know it can be a large and intimidating field when you're just starting out.
1222

1323
## What have we been up to?
1424

15-
While the working group is still in its infancy, we've already got several projects underway:
16-
17-
* The biggest success so far has been the creation of [`raw-window-handle`](https://github.com/rust-windowing/raw-window-handle), a library that provides a common interface that windowing libraries (such as `winit`) can use to talk to graphics libraries (such as `gfx-hal`). [Work is currently ongoing](https://github.com/rust-gamedev/wg/issues/26) to integrate this into various libraries, and once this is complete, it should be a big step towards making the ecosystem more decoupled.
18-
* [Discussions on how a pure Rust SPIR-V generator could be implemented](https://github.com/rust-gamedev/wg/issues/23) are currently ongoing, with the aim of reducing our reliance on `shaderc`.
19-
* We're running a [survey](https://users.rust-lang.org/t/survey-from-the-rust-game-development-working-group/31270), to help us understand the ecosystem better and to figure out how we can best serve its needs. If you're currently using Rust for game development, or even if you just have an interest in the idea of it, please give us your thoughts!
25+
While the working group is still in its infancy,
26+
we've already got several projects underway:
27+
28+
- The biggest success so far has been the creation of
29+
[`raw-window-handle`](https://github.com/rust-windowing/raw-window-handle),
30+
a library that provides a common interface that windowing libraries (such as `winit`)
31+
can use to talk to graphics libraries (such as `gfx-hal`).
32+
[Work is currently ongoing](https://github.com/rust-gamedev/wg/issues/26)
33+
to integrate this into various libraries, and once this is complete,
34+
it should be a big step towards making the ecosystem more decoupled.
35+
- [Discussions on how a pure Rust SPIR-V generator could be implemented](https://github.com/rust-gamedev/wg/issues/23)
36+
are currently ongoing, with the aim of reducing our reliance on `shaderc`.
37+
- We're running a [survey](https://users.rust-lang.org/t/survey-from-the-rust-game-development-working-group/31270),
38+
to help us understand the ecosystem better and to figure out
39+
how we can best serve its needs.
40+
If you're currently using Rust for game development,
41+
or even if you just have an interest in the idea of it,
42+
please give us your thoughts!
2043

2144
## How can I get involved?
2245

23-
Our main hub for co-ordination is our [Github repository](https://github.com/rust-gamedev/wg), where you can (and should!) raise issues calling out your ideas, proposals or problems with the Rust gamedev ecosystem. We also have a `#wg-gamedev` channel on the [official Rust Discord server](https://discord.gg/j6QJsMd), and get together for [meetings on Google Hangouts every other Wednesday](https://github.com/rust-gamedev/wg#join-the-fun). Come and join us!
46+
Our main hub for co-ordination is our [Github repository](https://github.com/rust-gamedev/wg),
47+
where you can (and should!) raise issues calling out your ideas, proposals
48+
or problems with the Rust gamedev ecosystem.
49+
We also have a `#wg-gamedev` channel on the [official Rust Discord server](https://discord.gg/j6QJsMd),
50+
and get together for [meetings on Google Hangouts every other Wednesday](https://github.com/rust-gamedev/wg#join-the-fun).
51+
Come and join us!
2452

2553
## What's next?
2654

27-
We're currently [putting together](https://github.com/rust-gamedev/rust-gamedev.github.io/issues/2) the first installment of a Rust game development newsletter - if you'd like to be notified when this goes live, please subscribe to our [RSS feed](https://rust-gamedev.github.io/feed.xml), or join us on [Discord](https://discord.gg/j6QJsMd)!
55+
We're currently [putting together](https://github.com/rust-gamedev/rust-gamedev.github.io/issues/2)
56+
the first installment of a Rust game development newsletter \-
57+
if you'd like to be notified when this goes live,
58+
please subscribe to our [RSS feed](https://rust-gamedev.github.io/feed.xml),
59+
or join us on [Discord](https://discord.gg/j6QJsMd)!

‎content/posts/newsletter-001/index.md

Copy file name to clipboardExpand all lines: content/posts/newsletter-001/index.md
+6-4Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,8 @@ _Discussions:
107107

108108
------
109109

110-
Also, check out ["About the future of nphysics: a pure rust 2D and 3D real-time physics engine"][future]
110+
Also, check out
111+
["About the future of nphysics: a pure rust 2D and 3D real-time physics engine"][future]
111112
\[[/r/rust](https://reddit.com/r/rust/comments/cm2858/about_the_future_of_nphysics_a_pure_rust_2d_and)].
112113

113114
[future]: https://www.patreon.com/posts/about-future-of-28917514
@@ -435,8 +436,8 @@ Special section for other news (up to 15) in a one-liner format:
435436
[with Voronoi diagrams for procedural destructions](https://twitter.com/VladZhukov0/status/1162462543530643457).
436437

437438
![Gameplay of Vlad's prototype](vlad-asteroinds-gameplay.gif)
438-
- [Azriel] published a devlog ["Charging Up"] - characters in [Will] can now charge up
439-
by holding the Attack button.
439+
- [Azriel] published a devlog ["Charging Up"] - characters in [Will]
440+
can now charge up by holding the Attack button.
440441

441442
![charging sprites from Will](will-charging.png)
442443
- [droprate](https://crates.io/crates/droprate) - a crate for choosing
@@ -473,7 +474,8 @@ Special section for other news (up to 15) in a one-liner format:
473474
- [\#26 "[Tracker] Better windowing/graphics inter-operation"](https://github.com/rust-gamedev/wg/issues/26)
474475
- [\#42 "[Discussion] A plan for crate stewardship"](https://github.com/rust-gamedev/wg/issues/42)
475476
- [rust-gamedev.github.io](https://github.com/rust-gamedev/rust-gamedev.github.io):
476-
- [\#2 "Newsletter"](https://github.com/rust-gamedev/rust-gamedev.github.io/issues/2) (so meta!)
477+
- [\#2 "Newsletter"](https://github.com/rust-gamedev/rust-gamedev.github.io/issues/2)
478+
(so meta!)
477479
- [\#4 "Create a rust-gamedev.github.io site"](https://github.com/rust-gamedev/rust-gamedev.github.io/issues/4)
478480

479481
## Meeting Minutes

‎content/posts/newsletter-002/index.md

Copy file name to clipboardExpand all lines: content/posts/newsletter-002/index.md
+4-2Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,8 @@ Updates include:
117117

118118
![bots attack](rox_clone_attack.png)
119119

120-
- [@webshinra](https://twitter.com/Webshinra) made progress with raycasted FOV in their hexagonal game.
120+
- [@webshinra](https://twitter.com/Webshinra) made progress with raycasted FOV
121+
in their hexagonal game.
121122

122123
![hexagonal map with two mechs, paths and visually blocked tiles](hex-fov.jpeg)
123124

@@ -503,7 +504,8 @@ _Discussions:
503504

504505
- **[minimum]** by ([@aclysma]) is a game development framework that provides
505506
basic tooling and a content authoring workflow;
506-
this month, rendering of draggable shapes in the editor and rotation/scaling were added
507+
this month, rendering of draggable shapes in the editor
508+
and rotation/scaling were added
507509
\[[YouTube demo](https://youtube.com/watch?v=BON_RvVFiWY)].
508510

509511
![editor with a bunch of shapes](minimum.png)

‎content/posts/newsletter-003/index.md

Copy file name to clipboardExpand all lines: content/posts/newsletter-003/index.md
+8-6Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ transparent = true
55
aliases = ["/2019/11/027/newsletter-003", "2019/11/07/newsletter-003.html"]
66
+++
77

8-
<!-- markdownlint-disable no-trailing-punctuation -->
9-
108
Welcome to the third issue of the Rust GameDev Workgroup’s
119
monthly newsletter.
1210

@@ -323,8 +321,8 @@ non-ascii code input, new icons, bugfixes, and better translations.
323321

324322
### [Godot][godot] and Rust
325323

326-
- ["Rendering a 2D game in 3D"](https://medium.com/@recallsingularity/rendering-a-2d-game-in-3d-bd24ddbee6eb) -
327-
[Tom Leys] is working on a “The Recall Singularity” [Godot][godot]/Rust game
324+
- ["Rendering a 2D game in 3D"](https://medium.com/@recallsingularity/rendering-a-2d-game-in-3d-bd24ddbee6eb)
325+
\- [Tom Leys] is working on a “The Recall Singularity” [Godot][godot]/Rust game
328326
about designing autonomous factory ships and stations
329327
and this month they published
330328
a post about evolution of the game's rendering.
@@ -338,7 +336,10 @@ non-ascii code input, new icons, bugfixes, and better translations.
338336
character physics, weapon system, cameras, animations system,
339337
dynamic damage system.
340338

341-
- ["Pong Clone in Godot Using 'gdnative' Rust Bindings"](https://reddit.com/r/godot/comments/dfam0p/i_made_a_pong_clone_in_godot_using_the_gdnative) - [@you-win] couldn't find any full game examples that used [godot-rust] so they made their own \[[source code](https://github.com/you-win/godot-pong-rust)].
339+
- ["Pong Clone in Godot Using 'gdnative' Rust Bindings"](https://reddit.com/r/godot/comments/dfam0p/i_made_a_pong_clone_in_godot_using_the_gdnative)
340+
\- [@you-win] couldn't find any full game examples that used [godot-rust]
341+
so they made their own
342+
\[[source code](https://github.com/you-win/godot-pong-rust)].
342343

343344
[godot]: https://godotengine.org
344345
[Tom Leys]: https://twitter.com/RecallSingular1
@@ -776,7 +777,8 @@ _Discussions:
776777
- [specs] and its related repositories [awesome-specs], [hibitset] and [shred]
777778
were moved to [Amethyst organization] \[[URLO][specs-moved]].
778779

779-
- [amethyst_physics v0.1.1 was released](https://www.reddit.com/r/rust_gamedev/comments/dm3jsf/amethyst_v011_contacts_events): now it's possible to fetch Rigid body contacts events.
780+
- [amethyst_physics v0.1.1 was released](https://www.reddit.com/r/rust_gamedev/comments/dm3jsf/amethyst_v011_contacts_events):
781+
now it's possible to fetch Rigid body contacts events.
780782

781783
- [@_AndreaCatania] published two video tutorials:
782784

‎content/posts/newsletter-004/index.md

Copy file name to clipboardExpand all lines: content/posts/newsletter-004/index.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ date = 2019-12-08
44
transparent = true
55
+++
66

7-
<!-- markdownlint-disable no-trailing-punctuation -->
8-
97
Welcome to the fourth issue of the Rust GameDev Workgroup’s
108
monthly newsletter.
119

@@ -426,7 +424,8 @@ A few notable additions are:
426424
- slimmed-down Rendy dependencies (memory and descriptor);
427425
- new skybox example.
428426

429-
Lyon has [updated examples](https://github.com/nical/lyon/pull/496) for this version, showing how to draw vector graphics on `wgpu`.
427+
Lyon has [updated examples](https://github.com/nical/lyon/pull/496)
428+
for this version, showing how to draw vector graphics on `wgpu`.
430429

431430
Also, `wgpu` is now a part of Gecko code base for powering the emerging WebGPU implementation.
432431

@@ -499,8 +498,8 @@ _Discussions:
499498

500499
^ Click to see [a demo video][skulpin-video].
501500

502-
[skulpin] by [@aclysma] provides an easy option for drawing hardware-accelerated 2D
503-
by combining Vulkan and [Skia].
501+
[skulpin] by [@aclysma] provides an easy option for drawing
502+
hardware-accelerated 2D by combining Vulkan and [Skia].
504503

505504
[skulpin]: https://github.com/aclysma/skulpin
506505
[skulpin-video]: https://www.youtube.com/watch?v=El99FgGSzfg
@@ -714,7 +713,8 @@ Check out the [online Demo][rust-nes-demo].
714713
- ["Future of nalgebra and math in Amethyst"](https://community.amethyst.rs/t/future-of-nalgebra-and-math-in-amethyst/1228)
715714
discussion;
716715

717-
- ["Skepticism about Rendy"](https://community.amethyst.rs/t/skepticism-about-rendy/1221) discussion;
716+
- ["Skepticism about Rendy"](https://community.amethyst.rs/t/skepticism-about-rendy/1221)
717+
discussion;
718718

719719
- [A thread by @obiwanus about long link time](https://community.amethyst.rs/t/obiwanuss-long-link-time-feedback/1207);
720720

‎content/posts/newsletter-005/index.md

Copy file name to clipboardExpand all lines: content/posts/newsletter-005/index.md
+12-7Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -353,8 +353,8 @@ but _fast_, both in terms of productivity and in terms of runtime performance.
353353
This month [ultraviolet v0.4][ultraviolet-v0-4] was released by [@fu5ha].
354354
It brings
355355
[transform](https://docs.rs/ultraviolet/0.4.3/ultraviolet/transform/index.html)
356-
& [projection](https://docs.rs/ultraviolet/0.4.3/ultraviolet/projection/index.html) modules
357-
and many smaller improvements.
356+
& [projection](https://docs.rs/ultraviolet/0.4.3/ultraviolet/projection/index.html)
357+
modules and many smaller improvements.
358358

359359
Check out the [full release announcement post][ultraviolet-v0-4].
360360

@@ -562,7 +562,10 @@ Main changes are:
562562
[@17cupsofcoffee] also posted [a little example][tetra-sound-polling-ex]
563563
of how you can implement pooling for sound effects
564564

565-
> This is handy for situations where you don't want more than X instances of the same sound playing at once (e.g. if the player is able to fire a weapon as fast as they can hit a button), etc...
565+
> This is handy for situations where you don't want more than X instances
566+
> of the same sound playing at once
567+
> (e.g. if the player is able to fire a weapon as fast as they can hit a button),
568+
> etc...
566569
567570
[tetra-sound-polling-ex]: https://gist.github.com/17cupsofcoffee/f5082a13626ddf0030075d542262c728
568571

@@ -626,7 +629,8 @@ and [voxel cone traced reflections] working in their voxel engine.
626629
![Rendology demo screenshot](rendology_hdr_0_4.png)
627630

628631
[Rendology] is a 3D rendering pipeline based on Glium and written in Rust.
629-
It features basic implementations of shadow mapping, deferred shading, a glow effect, FXAA and instanced rendering.
632+
It features basic implementations of shadow mapping, deferred shading,
633+
a glow effect, FXAA and instanced rendering.
630634

631635
An ["Introduction to Rendology"][rendology-into] article
632636
outlines some of the concepts of Rendology
@@ -693,7 +697,8 @@ Some of the December's updates:
693697
- a generic "effects" system;
694698
- cursed items, scrolls of remove curse, and item identification scrolls;
695699
- items that affect your attributes, generic statuses;
696-
- spells, spellbooks, weapon proc fx, mob special abilities, DoT, initiative +/- effects;
700+
- spells, spellbooks, weapon proc fx, mob special abilities,
701+
DoT, initiative +/- effects;
697702
- a dragon lair in a ruined fort;
698703
- multi-tile entities including pathfinding;
699704
- parameterized procgen of magic weaponry/armor;
@@ -856,8 +861,8 @@ Just an interesting Rust gamedev link from the past. :)
856861

857862
In the November of 2018,
858863
[@AndreaPessino] (Founder/CTO of [Ready At Dawn] Studios)
859-
released a [Modulator] crate and
860-
an awesome ["Modulator (Rust conding series)"][modulator-video] tutorial video about it.
864+
released a [Modulator] crate and an awesome
865+
["Modulator (Rust conding series)"][modulator-video] tutorial video about it.
861866

862867
[Modulator] is a Rust crate for abstracted, decoupled modulation sources.
863868

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.