Anki.Resources.SDK 0.0.3

.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Anki.Resources.SDK --version 0.0.3                

                    
                

            
NuGet\Install-Package Anki.Resources.SDK -Version 0.0.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Anki.Resources.SDK" Version="0.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Anki.Resources.SDK --version 0.0.3                

                    
                

            
#r "nuget: Anki.Resources.SDK, 0.0.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Anki.Resources.SDK as a Cake Addin
#addin nuget:?package=Anki.Resources.SDK&version=0.0.3

// Install Anki.Resources.SDK as a Cake Tool
#tool nuget:?package=Anki.Resources.SDK&version=0.0.3

Anki Vector/Cozmo Resources SDK (.NET)

This SDK allows manipulation of a resources folder from an "over the air update" OTA file for Anki Vector and the APK files for Anki Cozmo, in any .NET language (C#, VB.NET, F#) or language that interoperates (python) on Windows, Mac, and Linux. This requires that you know how to one of these files, and how extract the contents.

  • You can play the audio sounds on your computer

  • Examine the sprite-sequences, and other animations on your computer,

  • It has lint-like checking to help catch flaws in the resource bundle, so that they can be eliminated before shipping, reducing the test effort

There is some support for Cozmo resources.

Note: This SDK is not a product of Anki or Digital Dream Labs, and is not supported by them.

Getting Started

Download Microsoft development tools

If you working on Windows, download Visual Studio 2019 Community Edition to get started. This version is free for personal use.

To get started on Mac and Linux, you can download .NET Core 3.0.

To play audio you will need to add the following packages to your project:

To play with the sprites you will need to add the following packages to your project:

Download

SDK Example Code / Tutorial Programs

Some examples of how to use the SDK can be found at

Documentation

The documentation can be found at randym32.github.io/Anki.Resources.SDK

Browser configuration notes

The documentation, when browsed from a local filesystem, may require tweaking the browser.

Firefox

Go to about:config and make change to the following:

  • security.fileuri.strict_origin_policy set to false
  • privacy.file_unique_origin set to false
Chrome

You can not use Chrome with a local file system. You can, however, use an extension like "Web Server for Chrome"

Getting help

Being a new library, there is not yet an established usage pattern, clear place and patterns for getting help. Try

Contributing

View the Anki.Resources.SDK GitHub Project for information on contributing.

Grateful Acknowledgements and Special Thanks

Thank-you to the vgmstream and ww2ogg projects, whose efforts allowed decoding of the audio files.

Wayne Venables, you set a very high bar with Anki.Vector.SDK I lifted some of your index.md getting started information for here.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.5 708 7/13/2020
0.0.4 527 6/21/2020
0.0.3 590 6/7/2020
0.0.2 475 6/4/2020
0.0.1 527 6/3/2020

This allows reading and playing Vector and Cozmo sounds, and examining the sprites.
Preserves the case of the trigger names now, added a typed return for the CompositeImage ImageMap